pywatson/pyproject.toml at main · isaac-tes/pywatson · 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
[project]
name = "pywatson"
version = "0.0.1"
description = "A Python scientific project management tool for creating well-structured, reproducible scientific computing projects"
readme = "README.md"
license = {text = "MIT"}
authors = [
    { name = "isaac-tes", email = "i.tesfaye@tu-berlin.de" }
]
requires-python = ">=3.12"
keywords = ["scientific-computing", "project-management", "drwatson", "reproducibility", "hdf5"]
classifiers = [
    "Development Status :: 3 - Alpha",
    "Intended Audience :: Science/Research",
    "License :: OSI Approved :: MIT License",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Topic :: Scientific/Engineering",
]
dependencies = [
    "click>=8.3.0",
    "h5py>=3.14.0",
    "jinja2>=3.1.6",
    "numpy>=1.24.0",
    "pandas>=2.0.0",
    "pyyaml>=6.0.3",
    "rich>=14.1.0",
    "zarr>=2.0,<3",
]

[build-system]
requires = ["uv_build>=0.8.11,<0.9.0"]
build-backend = "uv_build"

[dependency-groups]
dev = [
    "pytest>=8.4.2",
    "ruff>=0.8.0",
    "mypy>=1.13.0",
    "ty>=0.0.1",
    "mkdocs-material>=9.7.4",
    "mkdocstrings-python>=2.0.3",
    "mkdocs-git-revision-date-localized-plugin>=1.5.1",
]

[project.scripts]
pywatson = "pywatson.core:cli"

# ---------------------------------------------------------------------------
# Ruff — linter & formatter configuration
# ---------------------------------------------------------------------------
[tool.ruff]
line-length = 99
target-version = "py312"

[tool.ruff.lint]
select = [
    "E",    # pycodestyle errors
    "F",    # pyflakes
    "W",    # pycodestyle warnings
    "I",    # isort (import sorting)
    "UP",   # pyupgrade (modernize syntax)
    "N",    # pep8-naming
    "D",    # pydocstyle (docstring conventions)
]
ignore = [
    "D100",   # Missing docstring in public module (too noisy for templates)
    "D102",   # Missing docstring in public method (too noisy in tests)
    "D104",   # Missing docstring in public package
    "D107",   # Missing docstring in __init__
    "D203",   # One blank line before class docstring (conflicts with D211)
    "D205",   # 1 blank line required between summary line and description
    "D212",   # Multi-line docstring summary on first line (conflicts with D213)
    "D213",   # Multi-line docstring summary on second line (conflicts with D212)
    "D301",   # Use r""" for docstrings with backslashes
    "D403",   # First word should be imperatively capitalized (breaks savename/uv names)
    "D415",   # First line should end with period, question mark, or exclamation point
    "D416",   # Section name should end with a colon
]

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

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

# ---------------------------------------------------------------------------
# Mypy — static type checking
# ---------------------------------------------------------------------------
[tool.mypy]
python_version = "3.12"
strict_optional = true
warn_unused_configs = true
warn_return_any = true
warn_unused_ignores = true
disallow_untyped_defs = false          # Allow gradual adoption

# ---------------------------------------------------------------------------
# Pytest
# ---------------------------------------------------------------------------
[tool.pytest.ini_options]
testpaths = ["tests"]
python_files = ["test_*.py"]
python_classes = ["Test*"]
python_functions = ["test_*"]
markers = [
    "docker: end-to-end tests that require the Docker daemon (run with: uv run pytest -m docker)",
]