pyproject.toml

[build-system]
# setuptools>=77 is needed for the SPDX `license` expression (PEP 639)
requires = ["setuptools>=77"]
build-backend = "setuptools.build_meta"

[project]
name = "dicogis"
dynamic = ["version"]
description = "Create Excel spreadsheet describing geographical data from a PostGIS Database or a file tree structure."
readme = "README.md"
license = "Apache-2.0"
requires-python = ">=3.11, <4"
authors = [{ name = "Julien Moura", email = "dev@ingeoveritas.com" }]
keywords = ["GDAL", "GIS", "INSPIRE", "OGR", "data management", "metadata"]
classifiers = [
    "Development Status :: 5 - Production/Stable",
    "Environment :: Win32 (MS Windows)",
    "Intended Audience :: End Users/Desktop",
    "Intended Audience :: Information Technology",
    "Operating System :: Microsoft :: Windows :: Windows 10",
    "Operating System :: Microsoft :: Windows :: Windows 11",
    "Operating System :: OS Independent",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: Implementation :: CPython",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Programming Language :: Python :: 3.14",
    "Topic :: Scientific/Engineering :: GIS",
]
dependencies = [
    "lxml>=5.1,<6.2",
    "notify-py>=0.3.42,<0.4",
    "numpy>=2.0.2,<2.6",
    "openpyxl>=3.0,<3.2",
    "pgserviceparser>=3.0.3,<4",
    "requests>=2.32.3,<3",
    "typer>=0.24.1,<1",
]

[project.optional-dependencies]
dev = [
    "pre-commit>=4.5,<5",
    "ruff>=0.15.20,<0.18.0",
]
doc = [
    "furo>=2024",
    "matplotlib>=3.8,<4",
    "myst-parser[linkify]>=2",
    "sphinx-autobuild>=2021",
    "sphinx-autodoc-typehints>=2.2.2,<3.7",
    "sphinx-click>=5",
    "sphinx-copybutton<1",
    "sphinx-design>=0.5,<1",
    "sphinx-sitemap>=2.4,<3",
    "sphinxcontrib-mermaid<3",
    "sphinxext-opengraph>=0.9",
]
gdal = ["gdal[numpy]>=3.5.0,<4"]
gui = ["PyQt6>=6.11,<6.13"]
packaging = [
    "pyinstaller>=6.8.0,<6.23",
    "pypiwin32==223 ; sys_platform == 'win32'",
]
test = [
    "packaging>=20,<27",
    "pytest-cov>=4,<8",
    "pytest-qt>=4.4,<5",
    "responses>=0.25,<0.27",
    "validators>=0.29.0,<0.37",
]

[project.scripts]
dicogis-cli = "dicogis.cli.main:dicogis_cli"

[project.gui-scripts]
dicogis-gui = "dicogis.ui.main:dicogis_gui"

[project.urls]
"Bug Reports" = "https://github.com/Guts/DicoGIS/issues/"
Docs = "https://guts.github.io/DicoGIS/"
Homepage = "https://github.com/Guts/DicoGIS/"
Source = "https://github.com/Guts/DicoGIS/"


[tool.coverage.report]
exclude_lines = [
    "if self.debug:",
    "pragma: no cover",
    "raise NotImplementedError",
    "if __name__ == .__main__.:",
]
ignore_errors = true
show_missing = true

[tool.coverage.run]
branch = true
omit = [".venv/*", "*migrations*", "*tests*"]


[tool.pytest.ini_options]
addopts = """
    --junitxml=junit/test-results.xml
    --cov-config=pyproject.toml
    --cov=dicogis
    --cov-report=html
    --cov-report=term
    --cov-report=xml
    --cov-append tests/
    --ignore=tests/_wip/
"""
junit_family = "xunit2"
minversion = "5.0"
norecursedirs = ".* build dev development dist docs CVS fixtures _darcs {arch} *.egg venv _wip  tests/container/data"
python_files = "test_*.py"
testpaths = ["tests"]

[tool.ruff]
line-length = 88
target-version = "py311"
exclude = [".git", "__pycache__", "old", "build", "dist", "tests/dev", ".venv*"]

[tool.ruff.format]
docstring-code-format = true
docstring-code-line-length = "dynamic"
indent-style = "space"
line-ending = "auto"
quote-style = "double"
skip-magic-trailing-comma = false

[tool.ruff.lint]
select = [
    "A",   # flake8-builtins
    "ANN", # flake8-annotations
    "B",   # flake8-bugbear
    "C90", # mccabe complexity
    "E",   # pycodestyle errors
    "ERA", # eradicate (commented code)
    "F",   # pyflakes
    "I",   # isort
    "LOG", # flake8-logging
    "N",   # pep8-naming
    "PTH", # flake8-pathlib
    "S",   # bandit security
    "TC",  # flake8-type-checking
    "T20", # flake8-print
    "W",   # pycodestyle warnings
]

ignore = [
    "ANN201", # Missing return type annotation for public function
    "ANN204", #  Missing return type annotation for special method `__init__`
    "ANN401", # Dynamically typed expressions (typing.Any) are disallowed in `**kwargs`
    "E501",   # line too long (handled by black)
    # "E203", # whitespace before ':'
    # "E226", # missing whitespace around arithmetic operator
    # "E24",  # multiple spaces after ','
]

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

[tool.ruff.lint.isort]
combine-as-imports = true
force-single-line = false
lines-after-imports = 2
split-on-trailing-comma = true

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

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

[tool.ruff.lint.per-file-ignores]
# Ignore `E402` (import violations) in all `__init__.py` files
"__init__.py" = ["E402"]
"builder/*.py" = ["T201"] # Ignore T20 (print) in packaging scripts
"docs/conf.py" = [
    "A001",
    "ANN001",
    "ANN2",
    "ERA001", # commented-out defaults kept from the sphinx-quickstart template
    "S101",
    "T20",
] # Ignore rules in Sphinx config
# Ignore rules in tests, subfolders included: asserts, annotations, random
# test data, fake credentials, literal "/tmp" paths never written to,
# subprocess calls to the running interpreter, unittest-style assertXxx helpers
"tests/**/*.py" = [
    "ANN001",
    "ANN003",
    "ANN2",
    "N802",
    "S101",
    "S106",
    "S108",
    "S311",
    "S603",
    "T20",
]


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

[tool.setuptools.package-data]
dicogis = [
    "locale/*",
    "bin/img/*",
    "bin/audio/*",
    "ui/*.ui",
    "ui/dialogs/*.ui",
    "ui/i18n/*.qm",
]

[tool.setuptools.packages.find]
where = ["."]
include = ["dicogis", "dicogis.*"]