pyproject.toml

[project]
name = "rra-building-density"
version = "0.0.1"
description = "Extraction and processing pipelines for a variety of building density products."
authors = [
    {name = "James Collins", email = "collijk@uw.edu"},
]
license = "BSD-3-Clause"
readme = "README.md"
requires-python = ">=3.12"
dependencies = [
    "click>=8.1.8",
    "requests>=2.32.3",
    "tqdm>=4.67.1",
    "rra-tools>=1.0.25",
    "geopandas>=1.0.1",
    "shapely>=2.0.6",
    "contextily>=1.6.2",
    "matplotlib>=3.10.0",
    "rasterio>=1.4.3",
    "scipy>=1.14.1",
    "seaborn>=0.13.2",
    "rasterra>=0.6.2",
    "pydantic>=2.10.4",
    "pyarrow>=18.1.0",
]

[project.urls]
homepage = "https://ihmeuw.github.io/rra-building-density"
repository = "https://github.com/ihmeuw/rra-building-density"
documentation = "https://ihmeuw.github.io/rra-building-density"

[project.scripts]
bdrun = "rra_building_density.cli:bdrun"
bdtask = "rra_building_density.cli:bdtask"

[tool.poetry]
packages = [
    { include = "rra_building_density", from = "src" }
]
requires-poetry = ">=2.0"

[tool.poetry.dependencies]
python = ">=3.12, <4.0"

# We keep the dev dependencies here instead of in the project optional dependencies
# so they're still installed by default with `poetry install`.
# They won't be installed or shipped with the package.
[tool.poetry.group.dev.dependencies]
# Things we want to put a lower bound on
mypy = "^1.15.0"
mkdocs-material = "^9.6.0"
pre-commit = "^4.0.0"
pytest = "^8.3.0"
ruff = "^0.9.7"
# Things we don't care about the version
mkdocstrings = {extras = ["python"], version = "*"}
mkdocs-table-reader-plugin = "*"
mkdocs-gen-files = "*"
mkdocs-literate-nav = "*"
mkdocs-section-index = "*"
pymdown-extensions = "*"
pytest-github-actions-annotate-failures = "*"
pytest-cov = "*"
python-kacl = "*"
types-pyyaml = "*"
types-requests = "*"
types-tqdm = "*"

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

[tool.ruff]
target-version = "py312" # The lowest supported version

[tool.ruff.lint]
# By default, enable all the lint rules.
# Add to the ignore list below if you don't want some rules.
# If you need some ignores for certain modules, see tool.ruff.lint.per-file-ignores below.
# For individual ignore cases, prefer inline `# noqa`s within the code.
select = ["ALL"]
ignore = [
    "COM812",   # flake8 missing trailing comma, formatter handles
    "ISC001",   # Implicit string concatenation
    "ANN",      # Type hints related, let mypy handle these.
    "D",        # Docstrings related, way too strict to our taste
    "RUF007",   # zip is idiomatic, this is a dumb check
    "RET505",   # Else after return, makes a lot of false positives
    "E501",     # Line too long, this is autoformatted
    "PLR0913",  # Too many args, bad check for CLIs
    "T201",     # We're using print for now until I have time to think about logging
    "RET504",   # Unneccesary assignment before return.  I like this pattern for debugging
    "PD901",    # df is fine
]

[tool.ruff.lint.per-file-ignores]
"tests/**" = [
    "S101",     # "Use of `assert` detected"
    "ARG",      # "Unused function argument". Fixtures are often unused.
    "S105",     # "Possible hardcoded password".
]
"scripts/**" = [
    "INP001",   # "Scripts are not part of a package."
]

[tool.ruff.lint.mccabe]
max-complexity = 10

[tool.ruff.lint.pep8-naming]
classmethod-decorators = [
    "classmethod",
    "pydantic.validator",
    "pydantic.root_validator",
]

[tool.ruff.lint.flake8-tidy-imports]
ban-relative-imports = "all"

[tool.pytest.ini_options]
addopts = """\
    --cov rra_building_density \
    --cov tests \
    --cov-report term-missing \
    --no-cov-on-fail \
"""

[tool.coverage.report]
fail_under = 100
exclude_lines = [
    'if TYPE_CHECKING:',
    'pragma: no cover'
]

[tool.mypy]
# This is the global mypy configuration.
# Avoid changing this!
strict = true  # See all the enabled flags `mypy --help | grep -A 10 'Strict mode'`
disallow_any_unimported = false
exclude = [
    "notebooks",
]

# If you need to ignore something for some specific module,
# add overrides for them. Avoid changing the global config!
# For example:
[[tool.mypy.overrides]]
module = [
    "affine.*",
    "geopandas.*",
    "shapely.*",
]
ignore_missing_imports = true