foamlib/pyproject.toml at main · gerlero/foamlib · 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
[build-system]
requires = ["uv_build>=0.9,<0.12"]
build-backend = "uv_build"

[project]
name = "foamlib"
version = "1.5.7"
license = "GPL-3.0-only"
license-files = ["LICENSE.txt"]
description = "Pythonic interface for working with OpenFOAM"
readme = "README.md"
requires-python = ">=3.10"
authors = [{name = "Gabriel S. Gerlero", email = "[email protected]"}]
classifiers = [
    "Development Status :: 5 - Production/Stable",
    "Framework :: AsyncIO",
    "Intended Audience :: Science/Research",
    "Intended Audience :: Developers",
    "Operating System :: POSIX",
    "Programming Language :: Python :: 3 :: Only",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Programming Language :: Python :: 3.14",
    "Topic :: Scientific/Engineering",
    "Topic :: Software Development",
    "Typing :: Typed",
]
dependencies = [
    "aioshutil>=1,<2",
    "multicollections>=1.0.4,<2",
    "numpy>=1,<3",
    "rich>=13,<16",
    "typing-extensions>=4.5,<5; python_version<'3.13'",
]

[project.optional-dependencies]
preprocessing = [
    "pandas>=1,<3",
    "pydantic>=2.0.0,<3",
]
postprocessing = [
    "pandas>=1,<3",
    "defusedxml>=0.7.1,<0.8",
]
examples = [
    "plotly>=6,<7",
    "scipy>=1,<2",
    "foamlib[preprocessing]",
    "foamlib[postprocessing]",
]

[project.urls]
Homepage = "https://github.com/gerlero/foamlib"
Repository = "https://github.com/gerlero/foamlib"
Documentation = "https://foamlib.readthedocs.io"

[dependency-groups]
preprocessing = ["foamlib[preprocessing]"]
postprocessing = ["foamlib[postprocessing]"]
examples = ["foamlib[examples]"]
lint = ["ruff"]
typing = [
    {include-group = "preprocessing"},
    {include-group = "postprocessing"},
    "pandas-stubs",
    "scipy-stubs",
    "ty",
    "types-defusedxml",
]
test = [
    {include-group = "preprocessing"},
    {include-group = "postprocessing"},
    "pytest>=7,<10",
    "pytest-asyncio>=0.21,<2",
    "pytest-cov",
    "scipy>=1,<2",
]
docs = [
    "foamlib[preprocessing]",
    "foamlib[postprocessing]",
    "sphinx>=5,<10",
    "sphinx_rtd_theme",
    "sphinxcontrib-mermaid"
]
benchmark = ["PyFoam"]
dev = [
    {include-group = "preprocessing"},
    {include-group = "postprocessing"},
    {include-group = "examples"},
    {include-group = "lint"},
    {include-group = "typing"},
    {include-group = "test"},
    {include-group = "docs"},
    {include-group = "benchmark"},
]

[tool.ruff.lint]
extend-select = ["ALL"]
extend-ignore = [
    "ANN401",
    "ARG004",
    "C901",
    "COM812",
    "E501",
    "ISC001",
    "PLR0911",
    "PLR0912",
    "PLR0913",
    "PLR0915",
    "PLR2004",
    "PYI041",
    "S101",
    "S603",
    "SLF001",
    "TID252"
]

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