EOS/pyproject.toml

[project]
name = "akkudoktor-eos"
dynamic = ["version"] # Get version information dynamically
authors = [
  { name="Andreas Schmitz", email="author@example.com" },
]
description = "This project provides a comprehensive solution for simulating and optimizing an energy system based on renewable energy sources. With a focus on photovoltaic (PV) systems, battery storage (batteries), load management (consumer requirements), heat pumps, electric vehicles, and consideration of electricity price data, this system enables forecasting and optimization of energy flow and costs over a specified period."
readme = "README.md"
license = {file = "LICENSE"}
requires-python = ">=3.11"
classifiers = [
    "Development Status :: 3 - Alpha",
    "Programming Language :: Python :: 3",
    "Operating System :: OS Independent",
]
dependencies = [
    "babel==2.18.0",
    "beautifulsoup4==4.15.0",
    "cachebox==6.2.8",
    "numpy==2.4.6",
    "numpydantic==1.10.0",
    "matplotlib==3.11.2",
    "contourpy==1.3.3",
    "fastapi[standard-no-fastapi-cloud-cli]==0.162.0",
    "fastapi_cli==0.0.32",
    "rich-toolkit==0.20.6",
    "python-fasthtml==0.14.14",
    "MonsterUI==1.0.48",
    "markdown-it-py==4.2.0",
    "mdit-py-plugins==0.6.1",
    "bokeh==3.9.2",
    "uvicorn==0.54.0",
    "scipy==1.17.1",
    "tzfpy==2.1.1",
    "deap==1.4.4",
    "requests==2.34.2",
    "pandas==3.1.0",
    "pendulum==3.3.0",
    "platformdirs==4.14.2",
    "psutil==7.2.2",
    "pvlib==0.16.1",
    "pydantic==2.14.2",
    "pydantic_extra_types==2.11.2",
    "statsmodels==0.15.0",
    "pydantic-settings==2.16.1",
    "linkify-it-py==2.2.0",
    "loguru==0.7.3",
    "lmdb==3.0.0",
]

[project.optional-dependencies]
dev = [
    # Pre-commit framework - basic package requirements handled by pre-commit itself
    # - pre-commit-hooks
    # - isort
    # - ruff
    # Mypy runs in this development environment, using uv.lock, including from pre-commit.
    # - pymarkdown
    # - commitizen - sync with requirements-dev.txt (if on pypi)
    #
    # !!! Sync .pre-commit-config.yaml with these dependencies !!!
    "pre-commit==4.7.0",
    "mypy==2.4.1",
    "types-requests==2.33.0.20261006", # for mypy
    "pandas-stubs==3.0.5.260914", # for mypy
    "tokenize-rt==6.2.0", # for mypy
    "types-docutils==0.23.0.20260923", # for mypy
    "types-PyYaml==6.0.12.20260906", # for mypy
    "scipy-stubs==1.17.1.5", # for mypy
    "types-psutil==7.2.2.20260906", # for mypy
    "commitizen==4.19.3",
    "deprecated==1.3.1", # for commitizen

    # Sphinx
    "sphinx==9.0.4",
    "sphinx_rtd_theme==3.1.0",
    "sphinx-tabs==3.5.0",
    "GitPython==3.2.1",
    "myst-parser==5.1.0",
    "docutils==0.21.2",
    "sphinxcontrib-mermaid==2.1.1   ",

    # Pytest
    "pytest==9.1.1",
    "pytest-asyncio==1.4.1",
    "pytest-cov==7.1.0",
    "pytest-xprocess==1.0.2",
    "coverage==7.16.2",
    "pypdf==6.21.4",
    # Browser tests of EOSdash (pytest --browser-test). The browser itself is installed
    # separately: uv run playwright install chromium
    "playwright==1.64.1",
]

[project.urls]
Homepage = "https://github.com/Akkudoktor-EOS/EOS"
Issues = "https://github.com/Akkudoktor-EOS/EOS/issues"

[build-system]
requires = ["setuptools>=77", "wheel"]
build-backend = "setuptools.build_meta"

[tool.setuptools.dynamic]
# version.txt must be generated
version = { file = "version.txt" }

[tool.setuptools.packages.find]
where = ["src/"]
include = ["akkudoktoreos"]

[tool.setuptools.package-data]
akkudoktoreos = ["*.json", "data/*.npz", ]

[tool.pyright]
# used in Pylance extension for language server
# type check is done by mypy, disable to avoid unwanted errors
typeCheckingMode = "off"

[tool.isort]
profile = "black"

[tool.ruff]
line-length = 100
exclude = [
    "tests",
    "scripts",
]
output-format = "full"

[tool.ruff.lint]
select = [
    "F",      # Enable all `Pyflakes` rules.
    "D",      # Enable all `pydocstyle` rules, limiting to those that adhere to the
              # Google convention via `convention = "google"`, below.
    "S",      # Enable all `flake8-bandit` rules.
]
ignore = [
   # Prevent errors due to ruff false positives
   # ------------------------------------------
   # On top of `Pyflakes (F)` to allow numpydantic Shape forward annotation
   "F722",    # forward-annotation-syntax-error: forward annotations that include invalid syntax.

    # Prevent errors for existing sources. Should be removed!!!
    # ---------------------------------------------------------
    # On top of `Pyflakes (F)`
    "F841",   # unused-variable: Local variable {name} is assigned to but never used
    # On top of `pydocstyle (D)`
    "D100",   # undocumented-public-module: Missing docstring in public module
    "D101",   # undocumented-public-class: Missing docstring in public class
    "D102",   # undocumented-public-method: Missing docstring in public method
    "D103",   # undocumented-public-function: Missing docstring in public function
    "D104",   # undocumented-public-package: Missing docstring in public package
    "D105",   # undocumented-magic-method: Missing docstring in magic method
    "D106",   # undocumented-public-nested-class: Missing docstring in public nested class
    "D107",   # undocumented-public-init: Missing docstring in __init__
    "D417",   # undocumented-param: Missing argument description in the docstring for {definition}: {name}
]

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

[tool.pytest.ini_options]
minversion = "8.3.3"
pythonpath = [ "src", ]
testpaths = [ "tests", ]
markers = [
    "docker: marks tests that require a local Docker engine",
    "browser: marks EOSdash tests that run in a headless browser (enable with --browser-test)",
]
filterwarnings = [
    # Treat pandas 4 deprecations in EOS code as errors; upstream callers remain visible.
    "error::pandas.errors.Pandas4Warning:akkudoktoreos\\.",
    # pvlib may exercise SciPy's root solver at night/zero irradiance; the resulting
    # PV output is explicitly verified as zero by integration tests.
    "ignore:invalid value encountered in divide:RuntimeWarning:scipy\\.optimize\\._chandrupatla",
]

[tool.mypy]
plugins = ["numpydantic.mypy", "pydantic.mypy"]
mypy_path= "src"
python_version = "3.13"
platform = "linux"
files = ["src", "tests"]
exclude = "class_soc_calc\\.py$"
check_untyped_defs = true
warn_unused_ignores = true
# Cached Pendulum analysis changes diagnostics between cold and warm runs with mypy 2.3.1.
incremental = false

[tool.pydantic-mypy]
init_typed = true

[[tool.mypy.overrides]]
module = "akkudoktoreos.*"
disallow_untyped_defs = true

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

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

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

# These dependencies do not publish complete PEP 561 typing information.
# Keep their imports explicit; installed typed libraries and EOS code are checked.
[[tool.mypy.overrides]]
module = ["cachebox", "fasthtml.*", "monsterui.*", "pvlib.*", "statsmodels.*"]
ignore_missing_imports = true

[tool.eos-filename-linter]
max_filename_length = 64

exclude = [
    ".git/**",
    ".venv/**",
    "docs/_build/**",
    "**/*.egg-info/**",
]

# Test modules except single test modules.
[[tool.eos-filename-linter.rules]]
name = "pytest module: test_ prefix, lowercase letters and digits without underscores or hyphens"
paths = ["tests/**/*.py"]
pattern = "^test_[a-z0-9]+\\.py$"
allowed_names = ["conftest.py"]
exclude = ["tests/single_test_*.py"]
suggestion = "test_prefix_alnum"

# Single test modules.
[[tool.eos-filename-linter.rules]]
name = "Single pytest modules"
paths = ["tests/single_test_*.py"]
pattern = "^single_test_[a-z0-9]+\\.py$"
suggestion = "single_test_prefix_alnum"

# Production Python modules.
[[tool.eos-filename-linter.rules]]
name = "python source module: lowercase letters and digits without underscores or hyphens"
paths = ["src/akkudoktoreos/**/*.py"]
pattern = "^[a-z][a-z0-9]*\\.py$"
allowed_names = ["__init__.py", "_version_date.py"]
suggestion = "lowercase_alnum"

# Standalone scripts.
[[tool.eos-filename-linter.rules]]
name = "python script: lowercase letters, digits, underscores without hyphens"
paths = ["scripts/**/*.py"]
pattern = "^[a-z][a-z0-9_]*\\.py$"
allowed_names = ["__init__.py"]
suggestion = "lowercase_snake"

[tool.commitizen]
# Only used as linter
name = "cz_conventional_commits"
version_scheme = "semver"

# Enforce commit message and branch style:
branch_validation = true
branch_pattern = "^(feat|fix|chore|docs|refactor|test)/[a-z0-9._-]+$"