pyproject.toml

[build-system]
requires = ["poetry-core>=1.0.0", "poetry-dynamic-versioning"]
build-backend = "poetry_dynamic_versioning.backend"


[tool.poetry]
name = "mergeplg"
version = "0.0.0"
authors = [
  "Christian Chwala <christian.chwala@kit.edu>",
]
homepage = "https://github.com/OpenSenseAction/mergeplg"
repository = "https://github.com/OpenSenseAction/mergeplg"
license = "BSD-3-Clause"
description = "A great package."
readme = "README.md"

classifiers = [
  "Development Status :: 1 - Planning",
  "Intended Audience :: Science/Research",
  "Intended Audience :: Developers",
  "Operating System :: OS Independent",
  "Topic :: Scientific/Engineering",
  "Typing :: Typed",
]

[tool.poetry.dependencies]
python = ">=3.10,<4.0.0"

furo = { version = ">=2023.08.17", optional = true }
myst_parser = { version = ">=0.13", optional = true }
pytest = { version = ">=6", optional = true }
pytest-cov = { version = ">=3", optional = true }
sphinx = { version = ">=7.0", optional = true }
sphinx_copybutton = { version = ">=0.3.0", optional = true }
sphinx-autodoc-typehints = { version = "*", optional = true }
docutils = { version = "!=0.21.post1", optional = true }
nbsphinx = { version = "*", optional = true }
nbmake = { version = ">=1.4.6", optional = true}
ipython = { version = "*", optional = true }
pykrige = ">=1.7.2"
poligrain = ">=0.3.0"
scipy = ">=1.14.0"
numpy = ">=2.0.1"
pandas = ">=2.2.2"
xarray = ">=2024.6.0"
netcdf4 = "<1.7.3"
h5py = "<=3.14"
wradlib = ">=2.0.3"
scikit-learn = ">=1.5.1"
scikit-gstat = ">=1.0.17"
numba = "*"

[tool.poetry.dev-dependencies]
pytest = ">= 6"
pytest-cov = ">= 3"

[tool.poetry.extras]
test = ["pytest", "pytest-cov", "nbmake"]
dev = ["pytest", "pytest-cov", "nbmake"]
docs = [
  "furo",
  "myst_parser",
  "sphinx",
  "sphinx_autodoc_typehints",
  "sphinx_copybutton",
  "docutils",
  "nbsphinx",
  "ipython",
]

[tool.poetry.group.dev.dependencies]
jupyterlab = ">=4.2.4"
pre-commit = ">=3.7.1"
pytest = ">=8.3.2"

[tool.poetry-dynamic-versioning]
enable = true
substitution.files = ["src/mergeplg/__init__.py"]


[tool.setuptools_scm]
write_to = "src/mergeplg/_version.py"


[tool.pytest.ini_options]
minversion = "6.0"
addopts = ["-ra", "--showlocals", "--strict-markers", "--strict-config"]
xfail_strict = true
filterwarnings = [
  "error",
  # TODO: Remove the line below once the problem is fixed upstream,
  # see https://github.com/OpenSenseAction/poligrain/pull/69
  #"ignore::DeprecationWarning:xarray.core.common:157",
  # Comment: Now ignoring all deprecation warning. This should of course
  # be removed at some point...
  "ignore::DeprecationWarning",
]
log_cli_level = "INFO"
testpaths = [
  "tests",
]


[tool.coverage]
run.source = ["mergeplg"]
report.exclude_also = [
  '\.\.\.',
  'if typing.TYPE_CHECKING:',
]

[tool.mypy]
files = ["src", "tests"]
python_version = "3.10"
warn_unused_configs = true
strict = true
enable_error_code = ["ignore-without-code", "redundant-expr", "truthy-bool"]
warn_unreachable = true
disallow_untyped_defs = false
disallow_incomplete_defs = false

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


[tool.ruff]
src = ["src"]
line-length = 88
target-version = "py310"
extend-include = ["*.ipynb"]

[tool.ruff.lint]
extend-select = [
  "B",        # flake8-bugbear
  "I",        # isort
  "ARG",      # flake8-unused-arguments
  "C4",       # flake8-comprehensions
  "EM",       # flake8-errmsg
  "ICN",      # flake8-import-conventions
  "G",        # flake8-logging-format
  "PGH",      # pygrep-hooks
  "PIE",      # flake8-pie
  "PL",       # pylint
  "PT",       # flake8-pytest-style
  "PTH",      # flake8-use-pathlib
  "RET",      # flake8-return
  "RUF",      # Ruff-specific
  "SIM",      # flake8-simplify
  "T20",      # flake8-print
  "UP",       # pyupgrade
  "YTT",      # flake8-2020
  "EXE",      # flake8-executable
  "NPY",      # NumPy specific rules
  "PD",       # pandas-vet
  "E",        # style errors
  "W",        # style warnings
  "F",        # flakes
  "D",        # pydocstyle
  "UP",       # pyupgrade
]
ignore = [
  "PLR09",    # Too many <...>
  "PLR2004",  # Magic value used in comparison
  "ISC001",   # Conflicts with formatter
  "PD011",    # not that bad, and actullty meant for pandas
  "D400",     # not always the best option
]

# Disabled because this would also be forced in notebooks where
# it does not make sense. We also do not require it now in module
# files. We do currently not do type checking anyway...
#isort.required-imports = ["from __future__ import annotations"]
# Uncomment if using a _compat.typing backport
# typing-modules = ["mergeplg._compat.typing"]

[tool.ruff.lint.per-file-ignores]
"tests/**" = ["T20", "D"]
"noxfile.py" = ["T20", "D100", "D200"]
"docs/notebooks/**" = ["T201"] # allow print statement in notebooks
"docs/conf.py" = ["D100", "A001"]

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

[tool.pylint]
py-version = "3.10"
ignore-paths = [".*/_version.py"]
reports.output-format = "colorized"
similarities.ignore-imports = "yes"
messages_control.disable = [
  "design",
  "fixme",
  "line-too-long",
  "missing-module-docstring",
  "missing-function-docstring",
  "wrong-import-position",
]