pyproject.toml

[project]
name = "robin"
description = "population generation using variation auto-encoders"
readme = "README.md"
requires-python = ">=3.12"
classifiers = [
        "Development Status :: 2 - Pre-Alpha",
        "Intended Audience :: Developers",
        "License :: OSI Approved :: MIT License",
        "Natural Language :: English",
        "Programming Language :: Python :: 3",
    ]

authors = [
    { name = "Fred Shone", email = "26383933+fredshone@users.noreply.github.com" },
]
keywords = ["synthetic census", "synthetic population", "generation", "vae"]
license = { text = "MIT" }
dynamic = ["version"]
dependencies = [
  "matplotlib",
  "numpy",
  "pandas",
  "torch",
  "pytorch-lightning",
  "jupyter",
  "jupyter_contrib_nbextensions",
  "mike >= 2, < 3",
  "mkdocs < 1.6",
  "mkdocs-material >= 9.4, < 10",
  "mkdocs-click < 0.7",
  "mkdocs-jupyter < 0.24.7",
  "mkdocstrings-python < 2",
  "nbmake >= 1.5.1, < 2",
  "pre-commit < 4",
  "pytest",
  "pytest-cov",
  "pytest-mock",
  "pytest-timeout",
  "pytest-xdist",
  "wandb>=0.21.1",
  "polars>=1.32.3",
  "optuna>=4.6.0",
  "optuna-dashboard>=0.20.0",
  "scikit-learn>=1.8.0",
  "playwright>=1.58.0",
  "chromium>=0.0.0",
]

[project.scripts]
robin="robin.cli:cli"
robin-export-notebook="robin.export_notebook:main"

[project.urls]
repository = "https://github.com/fredshone/robin"

[tool.setuptools.dynamic]
version = { attr = "robin.__version__" }

[tool.uv]
package = true

[tool.uv.sources]
torch = [
  { index = "pytorch-cu128", marker = "sys_platform == 'win32'" },
  { index = "pytorch-cu121", marker = "sys_platform == 'linux'" },
]

[[tool.uv.index]]
name = "pytorch-cu128"
url = "https://download.pytorch.org/whl/cu128"
explicit = true

[[tool.uv.index]]
name = "pytorch-cu121"
url = "https://download.pytorch.org/whl/cu121"
explicit = true

[tool.pytest.ini_options]
minversion = "6.0"
addopts = "-rav --strict-markers -n1 --nbmake --nbmake-kernel=robin --cov --cov-report=xml --cov-config=pyproject.toml -m 'not high_mem' -p no:memray"
testpaths = ["tests"]
# to mark a test, decorate it with `@pytest.mark.[marker-name]`
markers = ["high_mem", "limit_memory"]
filterwarnings = [
    # https://github.com/pytest-dev/pytest-xdist/issues/825
    "ignore:The --rsyncdir command line argument and rsyncdirs config variable are deprecated.:DeprecationWarning",
]

[tool.coverage.run]
branch = true
source = ["src/"]

[tool.coverage.report]
fail_under = 60

[tool.coverage.html]
directory = "reports/coverage"

[tool.coverage.xml]
output = "reports/coverage/coverage.xml"

[tool.black]
line-length = 80
skip_magic_trailing_comma = true

[tool.ruff]
line-length = 80
lint.select = ["E", "F", "I", "Q"]
lint.ignore = [
    "E501", # line too long: Black will handle this.
    "D1",   # Ignore missing docstrings in public functions/modules. There are just too many of them missing...
]

# Allow unused variables when underscore-prefixed.
lint.dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"

# Exclude a variety of commonly ignored directories.
exclude = [".*", "__pypackages__", "build", "dist", "venv", "reports/"]

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

[tool.ruff.lint.mccabe]
# Unlike Flake8, default to a complexity level of 10.
max-complexity = 10

# Ignore `E402` (import violations) and `F401` (unused imports) in all `__init__.py` files
[tool.ruff.lint.per-file-ignores]
"__init__.py" = ["E402", "F401"]
"*.ipynb" = ["E402"]

# Ignore `E402` for all notebooks
[tool.nbqa.addopts]
ruff = ["--extend-ignore=E402"]

[tool.ruff.lint.flake8-quotes]
docstring-quotes = "double"

[tool.setuptools.packages.find]
where = ["src"]
include = ["robin*"]

[tool.setuptools.package-data]
# Add file globs from the source code directory if they include non-py files that should be packaged
# E.g. "fixtures/**/*"
robin = []

[build-system]
requires = ["setuptools"]
build-backend = "setuptools.build_meta"

[dependency-groups]
dev = [
    "pytest>=9.0.2",
    "pytest-xdist>=3.8.0",
]