pyproject.toml

# --- Build System -------------------------------------------------------------
[build-system]
requires = ["setuptools>=61", "wheel"]
build-backend = "setuptools.build_meta"

# --- Project Metadata ---------------------------------------------------------
[project]
name = "nutree"
version = "1.2.1.dev1"
description = "Organize and query arbitrary Python objects as a tree — with clones, diffing, and graph export built in."
readme = "README.md"
license = {file = "LICENSE.txt"}
authors = [
    {name = "Martin Wendt", email = "nutree@wwwendt.de"},
]
maintainers = [
    {name = "Martin Wendt", email = "nutree@wwwendt.de"},
]
keywords = ["tree", "data structure", "digraph", "graph", "nodes", "hierarchy", "treelib"]
classifiers = [
    # "Development Status :: 3 - Alpha",
    # "Development Status :: 4 - Beta",
    "Development Status :: 5 - Production/Stable",
    "Environment :: Console",
    "Intended Audience :: Developers",
    "License :: OSI Approved :: MIT License",
    "Operating System :: OS Independent",
    "Programming Language :: Python",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3 :: Only",
    # "Programming Language :: Python :: 3.7  # EOL 2023-06-27",
    # "Programming Language :: Python :: 3.8  # EOL 2024-10",
    # "Programming Language :: Python :: 3.9", # EOL 2025-10
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Programming Language :: Python :: 3.14",
    "Programming Language :: Python :: 3.15",
    "Topic :: Software Development :: Libraries :: Python Modules",
]
# Minimal Python version that is supported by nutree (see also MIN_PYTHON_VERSION_INFO)
requires-python = ">=3.10"
dependencies = [
    "typing_extensions>=4.0",
]

[project.optional-dependencies]
graph = ["pydot", "rdflib", "graphviz"]
random = ["fabulist"]
all = ["pydot", "rdflib", "graphviz", "fabulist"]

[tool.uv.sources]
# benchman = {path = "../benchman", editable = true}

[dependency-groups]
dev = [
    "benchman",
    "fabulist",
    "ipykernel",
    "lxml",
    "notebook",
    "pre-commit",
    "pydot",
    "pytest",
    "pytest-cov",
    "pytest-html",
    "PyYAML",
    "rdflib",
    "ruff>=0.15",
    "Sphinx",
    "furo",
    "myst-parser[linkify]",
    "sphinxcontrib-googleanalytics",
    "sphinxcontrib-mermaid",
    "sphinx-rtd-theme",
    "tox",
    "tox-uv",
    "yabs",
    "ty>=0.0.69",
]

[project.urls]
Homepage = "https://github.com/mar10/nutree/"
"Bug Tracker" = "https://github.com/mar10/nutree/issues"
"Source Code" = "https://github.com/mar10/nutree"
Documentation = "https://nutree.readthedocs.io/"
Download = "https://github.com/mar10/nutree/releases/latest"

# --- Setuptools Configuration -------------------------------------------------
# [tool.setuptools.packages.find]
# where = ["."]
# exclude = ["tests*"]

# [tool.setuptools.package-data]
# nutree = ["py.typed"]


# --- Ruff Settings ------------------------------------------------------------
[tool.ruff]
target-version = "py310"
src = ["nutree", "tests"]

[tool.ruff.lint]
select = [
  "B", # bugbear
  # "D",   # pydocstyle
  "E",  # pycodestyle
  "F",  # pyflakes
  "G",  # flake8-logging-format
  "I",  # isort
  "T",  # print, ...
  "UP", # pyupgrade
]

# extend-select = ["ANN", "PYI"]
# preview = true

ignore = [
  "E721",  #  Do not compare types, use `isinstance()`
]

[tool.ruff.lint.per-file-ignores]
# Jupyter Notebooks
"*.ipynb" = [
  "T20",  # print statement
  "E402",  # module level import not at top of file
]

# [tool.ruff.isort]
# case-sensitive = true

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

# --- ty Settings --------------------------------------------------------------
[tool.ty.src]
include = ["nutree", "tests"]
exclude = [
    "tests/test_typing.py",
    "tests/test_typing_concept.py",
]

[tool.ty.analysis]
replace-imports-with-any = [
    "fabulist.**",
    "pydot.**",
    "pytest.**",
    "pympler.**",
    "rdflib.**",
]

[tool.ty.rules]
missing-type-argument = "error"
possibly-unresolved-reference = "warn"

# --- Pytest and Coverage Settings ---------------------------------------------
[tool.pytest.ini_options]
# addopts = "-ra -q --cov=nutree --cov-report=html"
addopts = "-ra -q --cov=nutree"
# addopts = "--cov=nutree --cov-report=html --cov-report=term-missing"

markers = [
    "benchmarks: include slow benchmarks (enable with '-m benchmarks')",
    # "slow: marks tests as slow (deselect with '-m \"not slow\"')",
    # "serial",
]

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

[tool.coverage.report]
precision = 1
# show_missing = true
sort = "Name"
exclude_lines = [
    "pragma: no cover",
    "raise NotImplementedError",
    "if __name__ == .__main__.:",
    "if TYPE_CHECKING:",
]
exclude_also = [
    # 1. Exclude an except clause of a specific form:
    # "except ValueError:\\n\\s*assume\\(False\\)",
    # 2. Comments to turn coverage on and off:
    # "no cover: start(?s:.)*?no cover: stop",
    # 3. A pragma comment that excludes an entire file:
    # "\\A(?s:.*# pragma: exclude file.*)\\Z",
    "\\A(?s:.*# pragma: exclude-file-from-coverage.*)\\Z",
    ]

[tool.coverage.html]
directory = "build/coverage"