pyproject.toml

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

[project.optional-dependencies]
test = [
    "pytest",
    "scipy",
]
test_gis = [
    "pytest",
    "momepy",
]
rl_example = [
    "stable-baselines3",
    "seaborn",
    "mesa",
    "tensorboard"
]

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

[tool.ruff]
# See https://github.com/charliermarsh/ruff#rules for error code definitions.
lint.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
]
# Ignore list taken from https://github.com/psf/black/blob/master/.flake8
# E203	Whitespace before ':'
# E266	Too many leading '#' for block comment
# E501	Line too long (82 > 79 characters)
# W503	Line break occurred before a binary operator
# But we don't specify them because ruff's Black already
# checks for it.
# See https://github.com/charliermarsh/ruff/issues/1842#issuecomment-1381210185
lint.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
    "B007",  # Loop control variable `i` not used within loop body
    "N806",  # Variable `N` in function should be lowercase
    "N803",  # Argument name `N` should be lowercase
    "RUF012",  # Mutable class attributes should be annotated with `typing.ClassVar` TODO
    "S311",  # Standard pseudo-random generators are not suitable for cryptographic purposes TODO
    "B008",  # Do not perform function call `pyproj.CRS` in argument defaults TODO
    "S301",  # `pickle` and modules that wrap it can be unsafe when used to deserialize untrusted data, possible security issue TODO
    "ISC001",  # conflict with ruff format
]
# Hardcode to Python 3.8.
target-version = "py38"
extend-include = ["*.ipynb"]

[tool.isort]
profile = "black"
sections = ['FUTURE', 'STDLIB', 'THIRDPARTY', 'LOCALFOLDER']