pyproject.toml

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

[project]
name = "dfetch"
authors = [{ name = "Ben Spoor", email = "dfetch@spoor.cc" }]
description = "A vendoring tool for fetching and managing external dependencies."
readme = { file = "README.md", content-type = "text/markdown" }
requires-python = ">=3.10"
keywords = [
    "dfetch",
    "dependency management",
    "embedded development",
    "fetch tool",
    "vendoring",
    "multi-repo",
    "dependencies",
    "git",
    "svn",
    "package manager",
    "multi-project",
    "monorepo",
]
license = "MIT"
classifiers = [
    # Full list: https://pypi.python.org/pypi?%3Aaction=list_classifiers
    "Development Status :: 4 - Beta",
    "Environment :: Console",
    "Intended Audience :: Developers",
    "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",
    "Programming Language :: Python :: Implementation :: CPython",
    "Programming Language :: Python",
]
dependencies = [
    "PyYAML==6.0.3",
    "strictyaml==1.7.3",
    "rich==15.0.0",
    "typing-extensions==4.15.0",
    "tldextract==5.3.0",
    "sarif-om==1.0.4",
    "semver==3.0.4",
    "patch-ng==1.19.1",
    "cyclonedx-python-lib==11.7.0",
    "infer-license==0.1.0; python_version <= '3.10.0'",
    "infer-license==0.2.0; python_version > '3.10.0'",
    'setuptools; python_version >= "3.12"',                  # contains 'pkg_resources' for infer-license
]
dynamic = ["version"]

[project.urls]
Homepage = "https://dfetch-org.github.io/"
Documentation = "https://dfetch.readthedocs.io/"
Repository = "https://github.com/dfetch-org/dfetch"
Issues = "https://github.com/dfetch-org/dfetch/issues"
Changelog = "https://github.com/dfetch-org/dfetch/blob/main/CHANGELOG.rst"


[project.optional-dependencies]
development = [
    # Quality dependencies
    'black==26.3.1',
    'doc8==2.0.0',
    'pydocstyle==6.3.0',
    'radon==6.0.1',
    'xenon==0.9.3',
    'types-PyYAML==6.0.12.20260408',
    'codespell==2.4.2',
    'mypy==1.20.2',
    #'flake8==5.0.4', # version 6.x.x requires python >= 3.8.1 (but 3.7 support window is until 2023-06-27)
    'bandit==1.9.4',
    'vulture==2.16',
    'pyroma==5.0.1',
    'isort==8.0.1',
    'pylint==4.0.5',
    'pyright==1.1.409',
    'pyupgrade==3.21.2',
    "tomli; python_version < '3.11'", # Tomllib is default in 3.11, required for letting codespell read the pyproject.toml
    'pre-commit==4.6.0',
    'ruff==0.15.12',
    'hypothesis==6.152.4',
    'import-linter==2.11',
]
docs = [
    'sphinx==8.2.3',
    'sphinx-argparse==0.5.2',
    'plantweb==1.3.0',
    # 'sphinxcontrib.asciinema==0.4.2',
    'sphinx_design==0.6.1',
    'sphinx-sitemap==2.9.0',
    'sphinx-jsonschema==1.19.2',
    'sphinxcontrib-programoutput==0.19',
    'sphinx-tabs==3.5.0',
    'sphinx-autoissues==0.0.1',
    'sphinx-copybutton==0.5.2',
]
test = ['pytest==9.0.3', 'pytest-cov==7.1.0', 'behave==1.3.3', 'cyclonedx-python-lib[json-validation]==11.7.0']
casts = ['asciinema==2.4.0']
build = [
    'nuitka==4.0.8',
    "tomli; python_version < '3.11'", # Tomllib is default in 3.11, required for letting codespell read the pyproject.toml]
    "setuptools-scm==10.0.5", # For determining version
]
sbom = ["cyclonedx-bom==7.3.0"]
wheel = ["build==1.5.0"]

[project.scripts]
dfetch = "dfetch.__main__:main"

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

[tool.setuptools.package-data]
dfetch = ["resources/*.yaml"]

[tool.setuptools_scm]
local_scheme = "no-local-version"
version_scheme = "guess-next-dev"

[tool.black]
extend-exclude = "sphinxcontrib_asciinema"
target-version = ["py313"]

[tool.isort]
profile = "black"
skip = [
    "doc/_ext/sphinxcontrib_asciinema",
]

# See https://github.com/PyCQA/flake8/issues/234 😢
[tool.flake8]
max-line-length = 120
max-complexity = 10
select = "B,C,E,F,W,T4"
ignore = "W503"

[tool.mypy]
files = "dfetch"
ignore_missing_imports = true
strict = true
warn_unused_ignores = false

[tool.doc8]
ignore-path = "doc/_build,doc/static/uml/styles/plantuml-c4"
max-line-length = 120
verbose = 0
ignore = "D002,D004"

[tool.pylint.format]
max-line-length = 120
disable = "logging-fstring-interpolation"
min-similarity-lines = 10

[tool.pylint.MASTER]
ignore-paths = [
    "doc/_build/",
    "doc/_ext/sphinxcontrib_asciinema",
    "doc/conf.py",
    "doc/landing-page/_build/",
    "doc/landing-page/conf.py",
    "doc/static/uml/",
    "tests",
]

[tool.pydocstyle]
convention = "google"

[tool.pytest]
filterwarnings = [
    "ignore:.*Using or importing the ABCs.*is deprecated:DeprecationWarning",
    "ignore:.*the imp module.*is deprecated:DeprecationWarning",
]

[tool.coverage.run]
branch = true
source = ["dfetch"]
relative_files = true

[tool.coverage.report]
show_missing = true

[tool.codespell]
skip = "*.cast,./venv,**/plantuml-c4/**,./example,.mypy_cache,./doc/_build/**,./doc/landing-page/_build/**,./doc/_ext/sphinxcontrib_asciinema/**,./build,*.patch,.git,**/generate-casts/demo-magic/**,./doc/openssl/**"

[tool.ruff.lint.per-file-ignores]
"features/steps/*" = ["F811"]

[tool.pyright]
stubPath = "stubs"
exclude = ["doc/static/uml/generate_diagram.py", "./doc/_ext/sphinxcontrib_asciinema/", "./doc/_build", "**/node_modules", "**/__pycache__", "**/.*", "venv"]
# standard = ["dfetch", "features"]
reportMissingImports = false
reportMissingModuleSource = false
pythonVersion = "3.10"

[tool.nuitka]
mode = "standalone"
# jobs = "4" # Can be used to reduce memory usage, in case of compilation issues
# Enable below for debugging
# show-progress = true
assume-yes-for-downloads = true

lto = "auto" # Use link time optimizations if available and usable

include-data-dir="dfetch/resources=resources"
include-package-data="infer_license"
include-package="rich._unicode_data"
include-module="infer_license.licenses" # Explicitly add module to let nuitka discover the data

# python-flag = ["-OO"] # Cannot optimize (yet) commands rely on __doc__ being present

output-dir = "build"
output-filename-win = "dfetch.exe"
output-filename-linux = "dfetch"
output-filename-macos = "dfetch"

windows-icon-from-ico = "doc/images/favicon.ico"
linux-icon = "doc/images/dfetch_logo_only.png"

company-name = "dfetch-org"
product-version = "{VERSION}"
file-version = "{VERSION}"
product-name = "dfetch"
file-description = "A vendoring tool for fetching and managing external dependencies."

[tool.importlinter]
root_packages = ["dfetch"]

# Enforce C4 architecture: higher layers may import from lower layers, not vice versa.
# See Architecture.rst for more details on the architecture of dfetch.
[[tool.importlinter.contracts]]
name = "C4 architecture layers"
type = "layers"
layers = [
    "dfetch.commands",
    "dfetch.reporting",
    "dfetch.project",
    "dfetch.manifest | dfetch.vcs",
    "dfetch.util | dfetch.log | dfetch.terminal",
]