watertemplate/pyproject.toml at main · MinishLab/watertemplate · 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
[build-system]
requires = ["setuptools>=64", "setuptools_scm>=8"]
build-backend = "setuptools.build_meta"

[project]
name = "PACKAGE"
description = "DESCRIPTION"
authors = [{name = "NAME", email = "EMAIL"}]
readme = { file = "README.md", content-type = "text/markdown" }
dynamic = ["version"]
license = { file = "LICENSE" }
requires-python = ">=3.10"
keywords = []
classifiers = [
    "Development Status :: 3 - Alpha",
    "Intended Audience :: Developers",
    "License :: OSI Approved :: MIT License",
    "Programming Language :: Python :: 3 :: Only",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Natural Language :: English",
]

dependencies = [
]

[project.optional-dependencies]
dev = [
    "mypy>=1.0",
    "pre-commit>=3.0",
    "pydoclint>=0.5.3",
    "pytest>=8.0",
    "pytest-cov>=5.0",
    "ruff>=0.9.0",
]

[project.urls]
"Homepage" = "https://github.com/MinishLab/PACKAGE"
"Bug Reports" = "https://github.com/MinishLab/PACKAGE/issues"
"Source" = "https://github.com/MinishLab/PACKAGE"

[tool.setuptools]
packages = ["PACKAGE"]
license-files = ["LICENSE*"]

[tool.setuptools_scm]
# can be empty if no extra settings are needed, presence enables setuptools_scm

[tool.setuptools.dynamic]
version = {attr = "PACKAGE.version.__version__"}

[tool.ruff]
exclude = [".venv/"]
line-length = 120
target-version = "py310"

[tool.ruff.lint.per-file-ignores]
"tests/**" = ["ANN"]

[tool.ruff.lint]
select = [
    # Annotations: Enforce type annotations
    "ANN",
    # Complexity: Enforce a maximum cyclomatic complexity
    "C90",
    # Pydocstyle: Enforce docstrings
    "D",
    # Pycodestyle errors
    "E",
    # Remove unused imports
    "F",
    # Isort: Enforce import order
    "I",
    # Numpy: Enforce numpy style
    "NPY",
    # Print: Forbid print statements
    "T20",
]
ignore = [
    # Allow Any type
    "ANN401",
    # Pydocstyle ignores
    "D100", "D101", "D104", "D203", "D213", "D401",
]

[tool.pydoclint]
style = "sphinx"
exclude = "test_"
allow-init-docstring = true
arg-type-hints-in-docstring = false
check-return-types = false
require-return-section-when-returning-nothing = false

[tool.mypy]
python_version = "3.10"
warn_unused_configs = true
ignore_missing_imports = true

[tool.pytest.ini_options]
testpaths = ["tests"]
addopts = ["--tb=short", "--strict-markers", "--cov=PACKAGE", "--cov-report=term-missing"]

[tool.coverage.run]
relative_files = true

[tool.coverage.report]
skip_covered = true
exclude_also = ["if __name__ == .__main__.:", "@abstractmethod"]

[tool.uv]
exclude-newer = "1 week"