starprolog/pyproject.toml at main · Starlink/starprolog · 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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
[build-system]
requires = ["setuptools >= 77"]
build-backend = "setuptools.build_meta"

[project]
name = "starprolog"
version = "0.1.0"
description = "Parse and render Starlink-style source-code prologues"
readme = "README.md"
requires-python = ">=3.11"
license = "BSD-3-Clause"
license-files = ["COPYRIGHT", "LICENSE"]
authors = [
    {name = "Association of Universities for Research in Astronomy"},
]
classifiers = [
    "Development Status :: 2 - Pre-Alpha",
    "Operating System :: OS Independent",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Programming Language :: Python :: 3.14",
    "Topic :: Documentation",
    "Topic :: Software Development :: Documentation",
]
dependencies = [
    "click >= 8",
    "pydantic >= 2.12",
]

[project.optional-dependencies]
test = [
    "pytest >= 7.4",
]

[dependency-groups]
dev = [
    "mypy >= 1.14",
    "numpydoc >= 1.8",
    "pre-commit >= 4",
    "pytest >= 7.4",
    "ruff >= 0.14",
]

[project.scripts]
starprolog = "starprolog.cli:main"

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

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

[tool.pytest.ini_options]
testpaths = ["tests"]

[tool.coverage.report]
show_missing = true
exclude_lines = [
    "pragma: no cover",
    "raise AssertionError",
    "raise NotImplementedError",
    "if __name__ == .__main__.",
    "if TYPE_CHECKING:",
]

[tool.ruff]
line-length = 110
target-version = "py311"

[tool.ruff.lint]
select = [
    "E",       # pycodestyle errors
    "F",       # pyflakes
    "N",       # pep8-naming
    "W",       # pycodestyle warnings
    "D",       # pydocstyle
    "I",       # isort
    "C4",      # comprehensions
    "UP",      # pyupgrade
    "PT",      # pytest style
    "RUF022",  # sorted __all__
]
extend-select = ["RUF100"]
ignore = [
    "D100",
    "D102",
    "D104",
    "D105",
    "D107",
    "D200",
    "D205",
    "D400",
]

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

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

[tool.ruff.format]
docstring-code-format = true
docstring-code-line-length = 79

[tool.pydocstyle]
convention = "numpy"
add-ignore = ["D100", "D102", "D104", "D105", "D107", "D200", "D205", "D400"]

[tool.numpydoc_validation]
checks = [
    "all",
    "SA01",
    "EX01",
    "SS06",
    "GL01",
    "GL08",
    "ES01",
    "RT01",
    "RT02",
    "SS05",
    "GL03",
    "PR04",
    "SA04",
]
exclude = [
    "^test_.*",
    "^__init__$",
    "\\._[a-zA-Z_]+$",
    "^cli\\.",
]

[tool.mypy]
warn_unused_configs = true
warn_redundant_casts = true
plugins = "pydantic.mypy"

[[tool.mypy.overrides]]
module = ["starprolog.*"]
disallow_untyped_defs = true
disallow_incomplete_defs = true
strict_equality = true
warn_unreachable = true
warn_unused_ignores = true