template-python/pyproject.toml at main · br3ndonland/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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
[project]
name = "template-python"
description = "Your project description here."
readme = "docs/index.md"
requires-python = ">=3.11,<4"
license = "MIT"
authors = [{ name = "Your Name" }]
classifiers = [
  "Natural Language :: English",
  "Programming Language :: Python :: 3",
  "Programming Language :: Python :: 3.11",
  "Programming Language :: Python :: 3.12",
  "Programming Language :: Python :: 3.13",
  "Programming Language :: Python :: 3.14",
  "Typing :: Typed",
]
dependencies = []
dynamic = ["version"]

[project.urls]
Homepage = "https://github.com/br3ndonland/template-python"
Repository = "https://github.com/br3ndonland/template-python"

[project.optional-dependencies]

[dependency-groups]
checks = [
  "basedpyright>=1,<2",
  "ruff>=0.15,<0.16",
]
docs = [
  "zensical>=0.0.31",
]
tests = [
  "coverage[toml]>=7,<8",
  "pytest>=9,<10",
]

[build-system]
requires = ["hatchling>=1.26.3,<2"]
build-backend = "hatchling.build"

[tool.basedpyright]
pythonVersion = "3.11"

[tool.coverage.report]
exclude_lines = ["if TYPE_CHECKING:", "pragma: no cover"]
fail_under = 70
show_missing = true

[tool.coverage.run]
command_line = "-m pytest"
source_pkgs = ["template_python", "tests"]

[tool.coverage.paths]
template_python = ["src/template_python"]
tests = ["tests"]

[tool.hatch.build.targets.sdist]
include = ["src", "tests"]

[tool.hatch.build.targets.wheel]
packages = ["src/template_python"]

[tool.hatch.envs.ci]
builder = true
dev-mode = false
dependency-groups = [
  "checks",
  "tests",
]

[tool.hatch.envs.default]
dev-mode = true
dependency-groups = [
  "checks",
  "docs",
  "tests",
]

[tool.hatch.envs.default.scripts]
check = [
  "ruff check",
  "ruff format --check",
  "basedpyright",
  "npx -s -y prettier@'^3' . --check",
  "npx -s -y cspell --dot --gitignore *.md **/*.md",
]
format = [
  "ruff check --fix",
  "ruff format",
  "npx -s -y prettier@'^3' . --write",
]

[tool.hatch.envs.docs]
dev-mode = false
dependency-groups = [
  "docs",
]

[tool.hatch.envs.production]
dev-mode = false
dependency-groups = []

[tool.hatch.version]
path = "src/template_python/__init__.py"

[tool.pytest]
addopts = ["-q"]
minversion = "9.0"
testpaths = ["tests"]

[tool.ruff]
src = ["src", "tests"]

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

[tool.ruff.lint]
extend-select = ["I", "UP"]

[tool.ruff.lint.isort]
known-first-party = ["src", "tests"]