pyproject.toml

# --- PROJECT CONFIGURATION --- #


[build-system]
requires = ["setuptools>=67", "wheel", "setuptools-git-versioning>=1.13.3"]
build-backend = "setuptools.build_meta"

# Metadata (see https://peps.python.org/pep-0621/)
[project]
name = "nwp-consumer"
dynamic = ["version"] # Set automtically using git: https://setuptools-git-versioning.readthedocs.io/en/stable/
description = "Tool for aggregating raw NWP files into .zarr files"
readme = {file = "README.md", content-type = "text/markdown"}
requires-python = ">=3.11.0"
license = {text = "MIT License"}
authors = [
    { name = "Sol Cotton", email = "sol@openclimatefix.org"}
]
classifiers = ["Programming Language :: Python :: 3"]
dependencies = [
    "cfgrib == 0.9.13.0",
    "dask[distributed] == 2024.6.2",
    "docopt == 0.6.2",
    "ecmwf-api-client == 1.6.3",
    "fsspec[s3] == 2024.6.1",
    "huggingface-hub == 0.23.4",
    "marshmallow == 3.21.3",
    "marshmallow-dataclass == 8.7.0",
    "numpy == 2.0.0",
    "ocf-blosc2 == 0.0.4",
    "psutil == 6.0.0",
    "pyproj == 3.6.1",
    "requests == 2.32.3",
    "structlog == 24.2.0",
    "urllib3 == 2.0.7",
    "xarray == 2024.6.0",
    "zarr == 2.18.2",
    "sentry-sdk == 2.1.1"
]

[project.optional-dependencies]
test = [
    "botocore == 1.33.7",  # Required for moto, prevents installing the whole of boto3
    "flask == 3.0.0",
    "flask-cors == 4.0.0",
    "moto[s3,server] == 4.2.11",
    "unittest-xml-reporting == 3.2.0",
]
lint = [
    "mypy == 1.7.1",
    "python-lsp-server == 1.9.0",
    "ruff == 0.1.7",
]
dev = [
    "nwp-consumer[test,lint]"
]

[project.scripts]
nwp-consumer = "nwp_consumer.cmd.main:main" # Set the entrypoint for the CLI

[project.urls]
repository = "https://github.com/openclimatefix/nwp-consumer"

[tool.setuptools]
include-package-data = false

[tool.setuptools-git-versioning]
enabled = true

# --- LINTING AND TYPING CONFIGURATION --- #

# MyPy configuration
# * See https://mypy.readthedocs.io/en/stable/index.html
[tool.mypy]
python_version = "3.12"
warn_return_any = true
disallow_untyped_defs = true
plugins = [
    'numpy.typing.mypy_plugin'
]

# Ruff configuration
# * See https://beta.ruff.rs/docs/
[tool.ruff]
select = [
    "F",   # pyflakes
    "E",   # pycodestyle
    "W",   # whitespace and newlines
    "I",   # isort
    "UP",  # modernize
    "ANN", # flake8 type annotations
    "S",   # flake8 bandit
    "B",   # flake8 bugbear
    "C4",  # flake8 comprehensions
    "COM", # flake8 commas
    "T20", # flake8 print
    "SIM", # flake8 simplify
    "ARG", # flake8 unused arguments
    "DTZ", # flake8 datetimes
    "Q",   # flake8 quotes
    "TCH", # flake8 typecheck
    "D",   # pydocstyle
    "RUF", # ruff-specific rules
]
line-length = 100
indent-width = 4
# Use pydocstyle Google convention
# See https://www.pydocstyle.org/en/stable/error_codes.html
ignore = [
    "D203", "D213", "D215", "D400", "D401", "D404", "D406",
    "D407", "D408", "D409", "D413",
    "ANN101",
]
exclude = ["__init__.py"]
fixable = ["ALL"]

[tool.ruff.format]
quote-style = "double"
indent-style = "space"
line-ending = "auto"

[tool.ruff.per-file-ignores]
"test*" = ["D", "ANN"]