PyProBE/pyproject.toml at main · mohammedasher/PyProBE · 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
[build-system]
requires = ["setuptools", "setuptools-scm"]
build-backend = "setuptools.build_meta"

[tool.setuptools.packages.find]
exclude = [
    "htmlcov",
] # Exclude the coverage report file from setuptools package finder

[project]
name = "PyProBE"
version = "1.0.3"
requires-python = ">=3.11"
dependencies = [
    "numpy", # for numerical operations
    "matplotlib", # for plotting
    "polars", # for dataframes
    "fastexcel", # for reading Excel files
    "plotly", # for plotting
    "scikit-learn", # for statistical analysis
    "distinctipy", # for color palettes
    "streamlit", # for dashboard GUI
    "PyYAML", # for reading YAML files
    "ordered-set",
    "pydantic", # for data valiation
    "kaleido", # for displaying plotly figures as images
    "IPython", # for example notebooks
    "pybamm", # for battery modelling and experiment class
    "ray", # for parallel processing
    "deprecated", # for deprecation warnings
]

[project.optional-dependencies]
dev = [
    # linters and formatters
    "black",
    "flake8",
    "flake8-docstrings",
    "isort",
    "mypy",
    "pip-tools",
    "pre-commit",
    # pytest
    "pytest",
    "pytest-cov", # coverage
    "pytest-mypy", # type checking
    "pytest-mock", # mock objects
    "pytest-benchmark", # benchmarking
    "types-PyYAML",
    "types-toml",
    "types-Deprecated",
    # documentation
    "sphinx",
    "sphinx-tabs",
    "sphinxcontrib-bibtex", # for references
    "sphinx-design",
    "pydata-sphinx-theme", # for theme
    "nbsphinx", # integrate notebooks in docs
    "xlsxwriter", # write to Excel from polars
    "autodoc_pydantic",
]

[tool.mypy]
disallow_any_explicit = false
disallow_any_generics = true
warn_unreachable = true
disallow_untyped_defs = true
ignore_missing_imports = true
exclude = [".venv/", "docs/"]

[[tool.mypy.overrides]]
module = "tests.*"
disallow_untyped_defs = false
warn_unused_ignores = false

[[tool.mypy.overrides]]
module = "polars"
follow_imports = "skip"

[[tool.mypy.overrides]]
module = "deprecated.*"
ignore_missing_imports = true

[tool.isort]
profile = "black"

[tool.pytest.ini_options]
addopts = "-v --mypy -p no:warnings --cov=pyprobe --cov-report=html --doctest-modules --ignore=docs/ --ignore=pyprobe/"

[tool.coverage.report]
exclude_also = [
    "@overload"
]