pyproject.toml

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[tool.hatch.version]
path = "src/r2x/__version__.py"

[tool.hatch.metadata]
allow-direct-references=true

[project]
name = "r2x"
dynamic = ["version"]
authors = [
    { name = "Pedro Sanchez", email = "psanchez@nrel.gov" },
    { name = "Obika Kodi", email = "kodi.obika@nrel.gov" },
    { name = "Vivienne Liu", email = "vivienne.liu@nrel.gov"},
]
description = "ReEDS to X parser"
requires-python = ">=3.11,<3.13"
classifiers = [
    "Development Status :: 4 - Beta",
    "Intended Audience :: Developers",
    "License :: OSI Approved :: BSD License",
    "Topic :: Software Development :: Build Tools",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Operating System :: OS Independent",
]
dependencies = [
    "jsonschema~=4.23",
    "loguru~=0.7.2",
    "pandas>=2.2",
    "plexosdb~=0.1.0",
    "polars~=1.1.0",
    "pyyaml~=6.0.1",
    "rich~=13.7.1",
    "tables~=3.10.1",
    "h5py",
    "cvxpy~=1.5.3",
    "infrasys~=0.2",
]

[project.scripts]
r2x = "r2x.__main__:cli"

[dependency-groups]
dev = [
    "ipython>=8.28.0",
    "mypy~=1.11.0",
    "pre-commit>=4.0.1",
    "pytest>=8.3.3",
    "pytest-cov>=5.0.0",
    "ruff~=0.9",
    "types-pyyaml>=6.0.12.20240917",
    "bump2version>=1.0.1",
]
docs = [
    "autodoc-pydantic>=2.2.0",
    "ghp-import>=2.1.0",
    "myst-parser>=4.0.0",
    "sphinx-book-theme>=1.1.3",
    "sphinx-copybutton>=0.5.2",
    "sphinx-tabs>=3.4.7",
    "sphinxcontrib-mermaid>=1.0.0",
]

[tool.mypy]
exclude = [
    'plugins',
]
ignore_missing_imports=true

# mypy gets a false positive due to having pandas
[[tool.mypy.overrides]]
module = "polars"
follow_imports = "skip"

[tool.ruff]
line-length = 110
target-version = "py311"
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",
    "__pypackages__",
    "_build",
    "buck-out",
    "build",
    "dist",
    "site-packages",
    "venv",
]

[tool.ruff.lint]
select = [
    "E",   # pycodestyle
    "TD",  # flake-8 todos
    "PD",  # pandas vet
    "RUF", # Ruff rules
    "N",   # pep8
    "F",   # pyflakes
    "UP",  # pyupgrade
    "D",   # pydocstyle
    "C90", # Complex code
]
# Allow unused variables when underscore-prefixed.
dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
extend-ignore = ['D105', 'D107', 'D205', 'D415']
pydocstyle.convention = "numpy"

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

[tool.ruff.lint.per-file-ignores]
"__init__.py" = ["E402", "F401", "F403", "D104"]
"__main__.py" = ["E402", "F401", "D104"]
"**/{tests,docs,tools}/*" = ["D100", "D103", "E402"]
"src/r2x/models/*" = ["D"]

[tool.pytest.ini_options]
addopts = "-vvv"
testpaths = "tests"
pythonpath = [
  "src"
]
markers = [
    "exporters: Tests related to exporters",
    "exporter_utils: Tests related to exporters utils",
    "plexos: Tests related to plexos",
    "sienna: Tests related to sienna",
    "utils: Util functions"
]

[tool.coverage.run]
omit = [
    "tests/*",
    ]