-
Notifications
You must be signed in to change notification settings - Fork 0
/
pyproject.toml
100 lines (89 loc) · 3.51 KB
/
pyproject.toml
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
[project]
name = "mex-model"
version = "2.5.0"
description = "Conceptual and machine-readable versions of the MEx metadata model."
authors = [{ name = "MEx Team", email = "mex@rki.de" }]
readme = { file = "README.md", content-type = "text/markdown" }
license = { file = "LICENSE" }
urls = { Repository = "https://github.com/robert-koch-institut/mex-model" }
requires-python = "<3.13,>=3.11"
dependencies = []
optional-dependencies.dev = [
"ipdb>=0.13.1,<1",
"myst-parser>=4.0.0,<5",
"ruff>=0.5.4,<1",
"sphinx>=7.4.5,<8",
]
[tool.cruft]
template = "https://github.com/robert-koch-institut/mex-template"
skip = ["CHANGELOG.md", "mex", "tests"]
[tool.ipdb]
context = 5
[tool.pdm]
distribution = true
[tool.pdm.scripts]
update-all = { cmd = "pdm update --group :all --update-all --save-compatible" }
lock-all = { cmd = "pdm lock --group :all --refresh" }
install-all = { cmd = "pdm install --group :all --no-editable --no-lock" }
export-all = { cmd = "pdm export --group :all --no-hashes -f requirements" }
sphinx = { cmd = "pdm run sphinx-build -aE -b dirhtml docs docs/dist" }
doc = { composite = ["sphinx"] }
wheel = { cmd = "pdm build --no-sdist" }
lint = { cmd = "pre-commit run --all-files" }
all = { composite = ["install-all", "lint", "doc"] }
[tool.ruff]
fix = true
line-length = 88
show-fixes = true
[tool.ruff.format]
docstring-code-format = true
[tool.ruff.lint]
ignore = [
"D100", # Allow missing module docstring for brevity
"D104", # Allow missing package docstring for brevity
"D106", # Allow missing nested class docstring (eg pydantic Config)
"D203", # Disallow blank line before class docstring (inverse of D211)
"D213", # Disallow multi-line docstring starting at second line (inverse of D212)
"D406", # Allow section name ending with newline (google style compat)
"D407", # Allow missing dashed underline after section (google style compat)
"D413", # Allow missing blank line after last section (google style compat)
"N805", # Allow first argument of a method to be non-self (pydantic compat)
"N815", # Allow mixedCase variables in class scope (model compat)
"RUF012", # Allow mutable class attributes (pydantic compat)
]
select = [
"A", # Flake8 builtin shaddow
"B", # BugBear bug and issue finder
"C90", # McCabe complexity checker
"D", # Python docstring style checker
"E", # Python code style errors
"ERA", # Commented-out code detector
"F", # Pyflakes passive python checker
"I", # Isort import utility
"N", # Pep8 naming conventions
"PERF", # Lint performance anti-patterns
"RET", # Flake8 return statement checker
"RUF", # Ruff-specific rules
"S", # Bandit automated security testing
"T10", # Flake8 debug statement checker
"T20", # Flake8 print statement checker
"UP", # PyUpgrade syntax recommender
"W", # Python code style warnings
]
[tool.ruff.lint.per-file-ignores]
"tests/**" = [
"D101", # Allow missing docstring in public class for tests
"D102", # Allow missing docstring in public method for tests
"D103", # Allow missing docstring in public function for tests
"D107", # Allow missing docstring in `__init__` for tests
"E501", # Allow line too long in tests
"N807", # Allow mocking `__init__` for tests
"S101", # Allow use of `assert` in tests
]
[tool.ruff.lint.isort]
known-first-party = ["mex", "tests"]
[tool.ruff.lint.pydocstyle]
convention = "google"
[build-system]
requires = ["pdm-backend==2.4.2"]
build-backend = "pdm.backend"