pyproject.toml

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

[tool.hatch.build.targets.wheel]
    packages = ["examples", "gis", "rl"]

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

[project]
name = "mesa-models"
description = "Importable Mesa models."
license = {file = "LICENSE"}
requires-python = ">=3.12"
authors = [
    {name = "Project Mesa Team", email = "maintainers@projectmesa.dev"}
]
version = "0.1.0"
readme = "README.md"

[project.optional-dependencies]
test = [
    "pytest",
    "scipy",
    "mesa[rec] @ git+https://github.com/mesa/mesa@main",
]
test_gis = [
    "pytest",
    "momepy",
    "pytest-cov",
    "mesa[rec] @ git+https://github.com/mesa/mesa@main",
]
rl_example = [
    "stable-baselines3",
    "seaborn",
    "mesa @ git+https://github.com/mesa/mesa@main",
    "tensorboard"
]

[tool.codespell]
ignore-words-list = ["ist", "hart", "nD"]

[tool.ruff]
target-version = "py312"
extend-include = ["*.ipynb"]
extend-exclude = ["build"]

[tool.ruff.lint]
# See https://github.com/charliermarsh/ruff#rules for error code definitions.
select = [
    # "ANN", # annotations TODO
    "B", # bugbear
    "C4", # comprehensions
    "DTZ", # naive datetime
    "E", # style errors
    "F", # flakes
    "I", # import sorting
    "ISC", # string concatenation
    "N", # naming
    "PGH", # pygrep-hooks
    "PIE", # miscellaneous
    "PLC", # pylint convention
    "PLE", # pylint error
    # "PLR", # pylint refactor TODO
    "PLW", # pylint warning
    "Q", # quotes
    "RUF", # Ruff
    "S", # security
    "SIM", # simplify
    "T10", # debugger
    "UP", # upgrade
    "W", # style warnings
    "YTT", # sys.version
#    "D",  # docstring TODO
]
# Ignore list taken from https://github.com/psf/black/blob/master/.flake8
# E203	Whitespace before ':'
# E266	Too many leading '#' for block comment
# W503	Line break occurred before a binary operator
# But we don't specify them because ruff's formatter
# checks for it.
# See https://github.com/charliermarsh/ruff/issues/1842#issuecomment-1381210185
extend-ignore = [
  "E501",
  "S101",   # Use of `assert` detected
  "B017",   # `assertRaises(Exception)` should be considered evil TODO
  "PGH004", # Use specific rule codes when using `noqa` TODO
  "B905",   # `zip()` without an explicit `strict=` parameter
  "N802",   # Function name should be lowercase
  "N999",   # Invalid module name. We should revisit this in the future, TODO
  "S310",   # Audit URL open for permitted schemes. Allowing use of `file:` or custom schemes is often unexpected.
  "S603",   # `subprocess` call: check for execution of untrusted input
  "ISC001", # ruff format asks to disable this feature
  "S311",   # Standard pseudo-random generators are not suitable for cryptographic purposes
]

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