Skip to content

Commit 4f2aec5

Browse files
author
Dominik Falkner
committed
Add liccheck task and necessary dependency. Reorder comments.
Reorder comments is necessary to ensure the file stays nicely formatted. If a comment is place above a section the poetry tool will treat it as part of the previous section. Which in turn will cause unreadable (for a human) formatting in the pyproject.toml.
1 parent e53bda6 commit 4f2aec5

1 file changed

Lines changed: 11 additions & 10 deletions

File tree

‎{{ cookiecutter.__package_name_kebab_case }}/pyproject.toml‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# https://python-poetry.org/docs/pyproject/#poetry-and-pep-517
21
[build-system]
2+
# https://python-poetry.org/docs/pyproject/#poetry-and-pep-517
33
requires = ["poetry-core>=1.0.0"]
44
build-backend = "poetry.core.masonry.api"
55

6-
# https://python-poetry.org/docs/pyproject/
76
[tool.poetry]
7+
# https://python-poetry.org/docs/pyproject/
88
name = "{{ cookiecutter.__package_name_kebab_case }}"
99
version = "0.0.1"
1010
description = "{{ cookiecutter.package_description }}"
@@ -20,18 +20,18 @@ classifiers = [
2020
"Programming Language :: Python :: 3",
2121
]
2222

23-
# https://python-poetry.org/docs/repositories/#using-a-private-repository
2423
[[tool.poetry.source]]
24+
# https://python-poetry.org/docs/repositories/#using-a-private-repository
2525
name = "risc-pypi"
2626
url = "https://pypiserver.risc-software.at/simple/"
2727
priority = "explicit"
2828

29-
# https://python-poetry.org/docs/dependency-specification/
3029
[tool.poetry.dependencies]
30+
# https://python-poetry.org/docs/dependency-specification/
3131
python = "^{{ cookiecutter.python_version }}"
3232

33-
# https://python-poetry.org/docs/master/managing-dependencies/
3433
[tool.poetry.group.dev.dependencies]
34+
# https://python-poetry.org/docs/master/managing-dependencies/
3535
poethepoet = "^0.20.0"
3636
black = { version = "^23.3.0", extras = ["jupyter"] }
3737
ruff = "^0.0.272"
@@ -44,9 +44,10 @@ mkdocs = "^1.4.3"
4444
mkdocs-material = "^9.1.15"
4545
mkdocstrings = {extras = ["python"], version = "^0.22.0"}
4646
liccheck = "^0.9.2"
47+
setuptools = "^69.0.3"
4748

48-
# https://github.com/nat-n/poethepoet
4949
[tool.poe.tasks]
50+
# https://github.com/nat-n/poethepoet
5051
_format = "black ."
5152
_sort_imports = "isort ."
5253
_lint = "ruff check --fix ."
@@ -71,25 +72,25 @@ precommit = ["_format", "_sort_imports", "_lint"]
7172
check = ["_check_format", "_check_sort_imports", "_check_lint", "check_licenses"]
7273
test = "pytest"
7374

74-
# https://black.readthedocs.io/en/stable/usage_and_configuration/the_basics.html#configuration-via-a-file
7575
[tool.black]
76+
# https://black.readthedocs.io/en/stable/usage_and_configuration/the_basics.html#configuration-via-a-file
7677
line-length = 120
7778

78-
# https://pycqa.github.io/isort/docs/configuration/config_files
7979
[tool.isort]
80+
# https://pycqa.github.io/isort/docs/configuration/config_files
8081
profile = "black"
8182

82-
# https://docs.pytest.org/en/7.1.x/reference/customize.html
8383
[tool.pytest.ini_options]
84+
# https://docs.pytest.org/en/7.1.x/reference/customize.html
8485
addopts = "--color=yes --doctest-modules -ra --cov --cov-report=html --cov-report term --exitfirst --failed-first --strict-config --strict-markers --verbosity=2 --junitxml=python-junit.xml"
8586
xfail_strict = true
8687
pythonpath = ["{{ cookiecutter.__package_name_snake_case }}"]
8788
testpaths = ["{{ cookiecutter.__package_name_snake_case }}", "tests"]
8889
# ignore any of these paths
8990
norecursedirs = [ ]
9091

91-
# https://github.com/charliermarsh/ruff
9292
[tool.ruff]
93+
# https://github.com/charliermarsh/ruff
9394
fix = true
9495
ignore-init-module-imports = true
9596
line-length = 120

0 commit comments

Comments
 (0)