SophT/pyproject.toml at main · SophT-Team/SophT · 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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
[project]
name = "sopht"
version = "0.0.3"
description = "Scalable One-stop Platform for Hydroelastic Things (SOPHT)"
readme = "README.md"
authors = [
    {name = "Yashraj Bhosale", email = "bhosale2@illinois.edu"},
    {name = "Arman Tekinalp", email = "armant2@illinois.edu"},
    {name = "Songyuan Cui", email = "cui20@illinois.edu"}
]
maintainers = [
    {name = "Songyuan Cui", email = "cui20@illinois.edu"}
]
license = "MIT"
requires-python = ">=3.10, <3.14"
dependencies = [
    "numpy",
    "scipy",
    "numba",
    "sympy",
    "h5py",
    "pyelastica",
    "matplotlib",
    "pyfftw",
    "pystencils",
    "ffmpeg-python",
    "typing-extensions",
]

[project.urls]
Homepage = "https://github.com/SophT-Team/SophT"
Repository = "https://github.com/SophT-Team/SophT.git"
Issues = "https://github.com/SophT-Team/SophT/issues"

[project.optional-dependencies]
examples = [
    "click",
    # "coomm",
    "magneto_pyelastica",
]

# https://hatch.pypa.io/latest/config/build/#build-system
[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

# https://docs.astral.sh/uv/concepts/projects/dependencies/#development-dependencies
[dependency-groups]
tests = [
    "pytest",
    "coverage",
    "pytest-cov",
    "mypy",
]
lint = [
    "ruff"
]
dev = [
    "pre-commit",
]

[tool.uv]
default-groups = "all"

# https://docs.astral.sh/ruff/configuration/
[tool.ruff]
exclude = [
    ".bzr",
    ".direnv",
    ".eggs",
    ".git",
    ".git-rewrite",
    ".hg",
    ".ipynb_checkpoints",
    ".mypy_cache",
    ".nox",
    ".pants.d",
    ".pyenv",
    ".pytest_cache",
    ".pytype",
    ".ruff_cache",
    ".svn",
    ".tox",
    ".venv",
    ".vscode",
    "__pycache__",
    "__pypackages__",
    "_build",
    "buck-out",
    "build",
    "dist",
    "node_modules",
    "scripts",
    "site-packages",
    "venv",
]

line-length = 100
indent-width = 4

target-version = "py310"

[tool.ruff.lint]
select = ["ALL"]
ignore = [
    "ANN",     # missing type annotation (handled by mypy)
    "C901",    # too-complex
    "COM812",  # missing-trailing-comma
    "CPY001",  # Missing copyright notice at top of file
    # TODO: enable once the documentation styles are settled
    "D",       # pydocstyle
    "D203",    # blank line required before class docstring
    "D211",    # no-blank-line-before-class
    "D213",    # multi-line-summary-second-line
    "ERA001",  # commented-out-code
    "FBT",     # boolean trap
    "FIX002",  # line-contains-todo
    "N999",    # invalid-module-name
    "PLR0912", # too-many-branches
    "PLR0913", # too-many-arguments
    "PLR0915", # too-many-statements
    "PLR2004", # magic-value-comparison
    "S607",    # start-process-with-partial-path
    "TD002",   # Missing author in TODO
    "TD003",   # missing-todo-link
    "TRY003",  # raise-vanilla-args
]

# Allow fix for all enabled rules (when `--fix`) is provided.
fixable = ["ALL"]
unfixable = []

# Allow unused variables when underscore-prefixed.
dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"

[tool.ruff.format]
quote-style = "double"
indent-style = "space"
skip-magic-trailing-comma = false
line-ending = "auto"
docstring-code-format = false
docstring-code-line-length = "dynamic"

# https://mypy.readthedocs.io/en/stable/config_file.html
[tool.mypy]
python_version = "3.10"
pretty = true
show_traceback = true
color_output = true
check_untyped_defs = false
ignore_missing_imports = true
show_column_numbers = true
show_error_codes = true
show_error_context = true

# https://docs.pytest.org/en/stable/reference/customize.html
[tool.pytest.ini_options]
minversion = "6.0"
addopts = "-ra -q"
testpaths = ["tests"]
norecursedirs =["hooks", "*.egg", ".eggs", "dist", "build", "docs", ".tox", ".git", "__pycache__"]