pyproject.toml

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

[project]
name = "pysgn"
description = "A Python package for constructing synthetic geospatial networks"
license = { text = "MIT" }
requires-python = ">=3.10"
authors = [
    { name = "Boyu Wang", email = "bwang44@buffalo.edu" },
]
readme = "README.md"
dependencies = [
    "numpy",
    "pandas",
    "geopandas",
    "networkx",
    "scikit-learn",
    "scipy",
    "loguru",
    "tqdm",
]
dynamic = ["version"]

[project.optional-dependencies]
all = ["pysgn[dev,docs]"]
dev = [
  "pre-commit",
  "black[jupyter]",
  "ruff",
  "coverage",
  "pytest >= 4.6",
  "pytest-cov",
  "sphinx",
  "pytest-mock",
]
docs = [
  "sphinx",
  "ipython",
  "pydata_sphinx_theme",
  "seaborn",
  "myst_nb",
  "myst-parser",         # Markdown in Sphinx
  "ipywidgets",
  "matplotlib",
  "contextily",
  "jupyterlab",
  "jupyterlab-code-formatter",
  "jupyterlab_execute_time",
  "jupyterlab-lsp",
  "python-lsp-server",
  "isort",
]

[project.urls]
homepage = "https://github.com/wang-boyu/pysgn"
repository = "https://github.com/wang-boyu/pysgn"

[tool.hatch.build.targets.wheel]
packages = ["pysgn"]

[tool.hatch.version]
path = "pysgn/__init__.py"

[tool.pytest.ini_options]
addopts = "-ra -q"
testpaths = [
    "tests",
]

[tool.ruff]
line-length = 88
target-version = "py310"
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
]
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
    "RUF012", # Mutable class attributes should be annotated with `typing.ClassVar` 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
]
extend-exclude = ["docs", "build"]

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

[tool.mypy]
python_version = "3.10"
warn_return_any = true
warn_unused_configs = true
disallow_untyped_defs = true
check_untyped_defs = true

[tool.coverage.report]
exclude_lines = [
    "pragma: no cover",
    "def __repr__",
    "if self.debug:",
    "raise NotImplementedError",
    "if __name__ == .__main__.:",
    "pass",
    "raise ImportError",
]
ignore_errors = true
omit = [
    "tests/*",
    "setup.py",
]