pyproject.toml

[project]
name = "rics"
version = "5.0.1.dev1"
description = "My personal little ML engineering library."
authors = [
    { name = "Richard Sundqvist", email = "richard.sundqvist@live.se" },
]
license = { text = "MIT" }
readme = "README.md"
keywords = ["rics"]
classifiers = [
    "Development Status :: 5 - Production/Stable",
    "Intended Audience :: Developers",
    "Intended Audience :: Science/Research",
    "Operating System :: POSIX :: Linux",
    "Operating System :: MacOS",
    "Operating System :: Microsoft :: Windows",
    "License :: OSI Approved :: MIT License",
    "Natural Language :: English",
    "Typing :: Typed",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3 :: Only",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
]
requires-python = ">=3.11"

dependencies = [
    "pandas >= 2.0.3",
]

[project.optional-dependencies]
cli = [
    "click >= 8.1.0",
]
plotting = [
    "matplotlib",
    "seaborn"
]

[project.urls]
homepage = "https://github.com/rsundqvist/rics"
repository = "https://github.com/rsundqvist/rics"
documentation = "https://rics"
"Bug Tracker" = "https://github.com/rsundqvist/rics/issues"
"Changelog" = "https://github.com/rsundqvist/rics/blob/master/CHANGELOG.md"

[project.scripts]
mtimeit = "rics.performance.cli:main"  # TODO(6.0.0): Remove old entrypoint.

[tool.poetry.requires-plugins]
poetry-plugin-export = ">=1.8"

[tool.poetry.group.manual-extras.dependencies]
# Extras that must be available for docs + tests go here. Doc/test-only deps go in their respective groups.
croniter = "^2.0.1"
polars = { version = "^1.21.0", extras = ["pandas"] }

[tool.poetry.group.docs]
[tool.poetry.group.docs.dependencies]
# duplicate object warnings for sphinx>=4
# description: https://github.com/astropy/astropy/issues/11723
# https://github.com/astropy/astropy/pull/12270
sphinx = "~8.1.3"
pydata-sphinx-theme = "~0.16.1"
myst-parser = "~4.0.0"
nbsphinx = "~0.9.6"
ipython = "~8.31.0"

[tool.poetry.group.notebooks]
optional = true
[tool.poetry.group.notebooks.dependencies]
jupyterlab = "^4"
ipywidgets = "*"
jupyterlab-execute-time = "*"
tqdm = "*"

[tool.poetry.group.test.dependencies]
pytest = "^8.3.4"
xdoctest = "^1.2.0"
coverage = "^7.6.10"
pytest-cov = "^6.0.0"

scikit-learn = "^1.4.2"
dask = { version = "^2025.1.0", extras = ["dataframe"] }

[tool.poetry.group.devops.dependencies]
invoke = "^2.2.0"
mypy = "^1.15.0"
ruff = "^0.11.4"

safety = "^3.0.1"
codespell = "^2.2.6"
bump2version = "^1.0.1"

[tool.ruff]
line-length = 120
fix = true
unsafe-fixes = false
output-format = "grouped"

[tool.ruff.format]
docstring-code-format = true
docstring-code-line-length = 80
line-ending = "lf"

[tool.ruff.lint]
exclude = ["notebooks/*"]
select = [
    "ANN",
    "S",
    "I",
    "B",
    "D",
    "F",
    "W",
    "E",
    "SLOT",
    "SIM",
    "TID",
    "TD",
    "TCH",
    "ARG",
    "PTH",
    "NPY",
    "PD",
    "N",
    "PERF",
    "PLC",
    "PLE",
    "PLR",
    "PLW",
    "UP",
    "FURB",
    "RUF",
    "TRY",
]
ignore = [
    "D105", # Missing docstring in magic method
    "D107", # Missing docstring in `__init__`
    "ANN401",
    "TID252", # Prefer absolute imports over relative imports from parent modules
    "TRY003",
    "PD901", # Avoid using the generic variable name `df` for DataFrames
    "PLC0415", # `import` should be at the top-level of a file
    "PLR0913", #
    "SIM108", # Use ternary operator - coverage issue, see https://github.com/nedbat/coveragepy/issues/509
    "TD003", # Missing issue link
    "TC006", # Add quotes to type expression in `typing.cast()`
]

[tool.ruff.lint.per-file-ignores]
"tests/*" = [
    "D",
    "S101", # Allow 'assert' keyword
    "ANN",
    "PLR2004", # Allow magic values
]
"examples/*" = [
    "D205", # Clashes with sphinx_gallery (generated examples)
    "B007",
]

[tool.ruff.lint.pydocstyle]
convention = "google"
[tool.ruff.lint.pycodestyle]
max-line-length = 150

[tool.pytest]
[tool.pytest.ini_options]
filterwarnings = [
    "error",
    "ignore:Matplotlib is currently using agg:UserWarning",
    "ignore:.*rics.ml.time_split:DeprecationWarning",
]
log_file_level = 10
log_file = "pytest.log"
norecursedirs = [
    "**/cli_modules/*",
]

[build-system]
requires = ["poetry-core>=1.0.8"]
build-backend = "poetry.core.masonry.api"