research-code-python-starter-template/pyproject.toml at main · MTDickens/research-code-python-starter-template · 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
[build-system]
requires = ["setuptools", "setuptools-scm"]
build-backend = "setuptools.build_meta"

[project]
name = "python_starter"
version = "0.1.0"
description = "A basic starter for Python packages."
readme = "README.md"
requires-python = ">=3.10"
dependencies = [
   "hydra-core",
   "ipdb",
   "matplotlib",
   "numpy",
]

[project.optional-dependencies]
develop = ["pytest>=7.2.2", "pytest-xdist>=3.8.0", "ruff", "ty"]

[tool.setuptools.packages.find]
where = ["src"]

[tool.setuptools.package-data]
python_starter = ["py.typed"]

[tool.ruff]
line-length = 128
target-version = "py312"

[tool.ruff.lint]
select = ["E", "F", "W", "I", "D", "UP", "PL"]
ignore = [
    "D203", # 1 blank line required before class docstring (incompatible with D211)
    "D213", # Multi-line docstring summary should start at the second line (incompatible with D212)
    "F722", # jaxtyping uses strings in annotations that are not forward references (see ruff#9860)
]

[tool.ruff.lint.pylint]
max-args = 10
max-branches = 30
max-statements = 150

[tool.ruff.lint.isort]
known-first-party = ["python_starter"]

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

[tool.ruff.format]
quote-style = "double"
indent-style = "space"
docstring-code-format = true
docstring-code-line-length = "dynamic"

[tool.ty.environment]
python-version = "3.10"

[tool.ty.src]
include = ["src", "tests"]

[tool.ty.analysis]
respect-type-ignore-comments = true

[tool.uv.sources]
python_starter = { workspace = true }

[dependency-groups]
dev = ["python_starter"]