Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Some updates to pyproject.toml formatting and ruff rules #21

Merged
merged 7 commits into from
Oct 31, 2023
Merged

Some updates to pyproject.toml formatting and ruff rules #21

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
92d86e9
update pyproject
tlambert03 Oct 28, 2023
1553062
more updates
tlambert03 Oct 28, 2023
ab2dea3
update links
tlambert03 Oct 28, 2023
b572c50
uncomment
tlambert03 Oct 31, 2023
6a3d984
fix typo
tlambert03 Oct 31, 2023
68fbe43
Merge branch 'main' into ruff-rules
tlambert03 Oct 31, 2023
d72320e
Merge branch 'main' into ruff-rules
tlambert03 Oct 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 32 additions & 17 deletions project/pyproject.toml.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,15 @@
[build-system]
requires = ["hatchling"{%- if git_versioning -%}, "hatch-vcs"{%- endif %}]
build-backend = "hatchling.build"
# read more about configuring hatch at:
# https://hatch.pypa.io/latest/config/build/

{%- if git_versioning %}

# https://hatch.pypa.io/latest/config/metadata/
[tool.hatch.version]
source = "vcs"
{%- endif %}

# read more about configuring hatch at:
# https://hatch.pypa.io/latest/config/build/
[tool.hatch.build.targets.wheel]
only-include = ["src"]
sources = ["src"]
Expand All @@ -28,18 +27,26 @@ description = "{{ project_short_description }}"
readme = "README.md"
requires-python = ">=3.8"
license = { text = "{{ project_license }}" }
authors = [
{ name = "{{ author_name }}", email = "{{ author_email }}" },
]
authors = [{ name = "{{ author_name }}", email = "{{ author_email }}" }]
# https://pypi.org/classifiers/
classifiers = [
"Development Status :: 3 - Alpha",
{%- if project_license == "MIT" %}
"License :: OSI Approved :: MIT License",
{%- elif project_license == "Apache-2.0" %}
"License :: OSI Approved :: Apache Software License",
{%- elif project_license == "BSD-3-Clause" %}
"License :: OSI Approved :: BSD License",
{%- elif project_license == "GPL-3.0" %}
"License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
{%- endif %}
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
# "License :: OSI Approved :: BSD License",
# "Typing :: Typed",
"Programming Language :: Python :: 3.12",
"Typing :: Typed",
]
# add your package dependencies here
dependencies = []
Expand All @@ -57,7 +64,7 @@ dev = [
{%- if use_mypy %}
"mypy",{%- endif %}
"pdbpp", # https://github.com/pdbpp/pdbpp
{%- if use_precommit %}
{%- if use_pre_commit %}
"pre-commit",{%- endif %}
"rich", # https://github.com/Textualize/rich
{%- if use_ruff %}
Expand All @@ -68,6 +75,9 @@ dev = [
{% if github_username -%}
homepage = "https://github.com/{{github_username}}/{{project_name}}"
repository = "https://github.com/{{github_username}}/{{project_name}}"
{%- else -%}
# homepage = ""
# repository = ""
{%- endif %}

# Entry points
Expand All @@ -78,13 +88,14 @@ repository = "https://github.com/{{github_username}}/{{project_name}}"

# [project.entry-points."some.group"]
# tomatoes = "{{module_name}}:main_tomatoes"

{% if use_ruff -%}
# https://github.com/charliermarsh/ruff
# https://docs.astral.sh/ruff
[tool.ruff]
line-length = 88
target-version = "py38"
src = ["src"]
# https://beta.ruff.rs/docs/rules/
# https://docs.astral.sh/ruff/rules
select = [
"E", # style errors
"W", # style warnings
Expand All @@ -96,12 +107,14 @@ select = [
"B", # flake8-bugbear
"A001", # flake8-builtins
"RUF", # ruff-specific rules
"TCH", # flake8-type-checking
"TID", # flake8-tidy-imports
]
# I do this to get numpy-style docstrings AND retain
# D417 (Missing argument descriptions in the docstring)
# This is to get numpy-style docstrings AND retain D417
# (Missing argument descriptions in the docstring)
# otherwise, see:
# https://beta.ruff.rs/docs/faq/#does-ruff-support-numpy-or-google-style-docstrings
# https://github.com/charliermarsh/ruff/issues/2606
# https://docs.astral.sh/ruff/faq/#does-ruff-support-numpy-or-google-style-docstrings
# https://github.com/astral-sh/ruff/issues/2606
ignore = [
"D100", # Missing docstring in public module
"D107", # Missing docstring in __init__
Expand Down Expand Up @@ -133,6 +146,7 @@ pretty = true
# module = ["numpy.*",]
# ignore_errors = true
{%- endif %}

# https://docs.pytest.org/en/6.2.x/customize.html
[tool.pytest.ini_options]
minversion = "6.0"
Expand All @@ -148,7 +162,10 @@ exclude_lines = [
"except ImportError",
"\\.\\.\\.",
"raise NotImplementedError()",
"pass",
]
show_missing = true

[tool.coverage.run]
source = ["{{module_name}}"]

Expand All @@ -157,9 +174,7 @@ source = ["{{module_name}}"]
# (files that are in the repo but shouldn't go in the package)
[tool.check-manifest]
ignore = [
".github_changelog_generator",
".pre-commit-config.yaml",
".ruff_cache/**/*",
"setup.py",
"tests/**/*",
]