template-python/pyproject.toml at main · strg-at/template-python · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
[project]
name = "python-app-template"
version = "1.0.0"
description = "A Python app that reticulates splines."
readme = "README.md"
authors = [
  { name = "John Smith", email = "john@strg.at" },
]
requires-python = "==3.13.*"
dependencies = [
  "fastapi[all]>=0.115.6",
  "gunicorn>=23.0.0",
  "typer>=0.15.1",
  "prometheus_client>=0.11.0",
  "prometheus-fastapi-instrumentator (>=7.1.0,<8.0.0)",
  "structlog>=24.1.0",
  "rich>=14.0.0",
]

[dependency-groups]
dev = [
    "uvicorn==0.37.0",
    "basedpyright>=1.28.4",
    "debugpy>=1.8.14",
    "ruff>=0.11.2",
    "coverage>=7.6.10",
    "pdoc>=15.0.1",
    "pytest>=8.3.4",
    "pytest-mock>=3.14.0",
    "pytest-xdist>=3.6.1",
]

[project.optional-dependencies]
# Optional dependencies can be listed here.

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[project.scripts]  # https://docs.astral.sh/uv/concepts/projects/config/#command-line-interfaces
python-app-template = "python_app_template.cli:app"

[project.urls]  # https://packaging.python.org/en/latest/specifications/well-known-project-urls/#well-known-labels
homepage = "https://github.com/strg-at/template-python"
source = "https://github.com/strg-at/template-python"
changelog = "https://github.com/strg-at/template-python/blob/main/CHANGELOG.md"
releasenotes = "https://github.com/strg-at/template-python/releases"
documentation = "https://github.com/strg-at/template-python"
issues = "https://github.com/strg-at/template-python/issues"

[tool.coverage.report]  # https://coverage.readthedocs.io/en/latest/config.html#report
fail_under = 50
precision = 1
show_missing = true
skip_covered = true

[tool.coverage.run]  # https://coverage.readthedocs.io/en/latest/config.html#run
branch = true
command_line = "--module pytest"
data_file = "reports/.coverage"
source = ["python_app_template"]

[tool.coverage.xml]  # https://coverage.readthedocs.io/en/latest/config.html#xml
output = "reports/coverage.xml"

[tool.basedpyright]
typeCheckingMode = "recommended"
failOnWarnings = false
reportAny = false
reportUnusedCallResult = false
reportUnknownLambdaType = false

[tool.pytest.ini_options]  # https://docs.pytest.org/en/latest/reference/reference.html#ini-options-ref
addopts = "--color=yes --doctest-modules --exitfirst --failed-first --strict-config --strict-markers --verbosity=2 --junitxml=reports/pytest.xml"
filterwarnings = ["error", "ignore::DeprecationWarning"]
testpaths = ["python_app_template", "tests"]
xfail_strict = true

[tool.ruff]  # https://docs.astral.sh/ruff/settings/
line-length = 120
src = ["python_app_template", "tests"]
target-version = "py312"

[tool.ruff.format]
docstring-code-format = true

[tool.ruff.lint]

[tool.ruff.lint.flake8-tidy-imports]
ban-relative-imports = "all"

[tool.ruff.lint.pycodestyle]
max-doc-length = 100

[tool.ruff.lint.pydocstyle]
convention = "numpy"