pyproject.toml

[build-system]
build-backend = "hatchling.build"
requires = [
  "hatch-fancy-pypi-readme>=25.1",
  "hatch-vcs>=0.5",
  "hatchling>=1.32.4",
]

[project]
name = "pyproject-api"
import-names = [ "pyproject_api" ]
description = "API to interact with the python pyproject.toml based projects"
keywords = [
  "build-system",
  "metadata",
  "pyproject",
]
license = "MIT"
maintainers = [
  { name = "Bernát Gábor", email = "gaborjbernat@gmail.com" },
]
authors = [
  { name = "Bernát Gábor", email = "gaborjbernat@gmail.com" },
]
requires-python = ">=3.11"
classifiers = [
  "Development Status :: 5 - Production/Stable",
  "Intended Audience :: Developers",
  "Operating System :: MacOS :: MacOS X",
  "Operating System :: Microsoft :: Windows",
  "Operating System :: POSIX",
  "Programming Language :: Python :: 3 :: Only",
  "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",
  "Topic :: Utilities",
]
dynamic = [
  "readme",
  "version",
]
dependencies = [
  "packaging>=26.3",
]
urls.Changelog = "https://github.com/tox-dev/pyproject-api/blob/main/docs/changelog.rst"
urls.Homepage = "https://pyproject-api.readthedocs.io"
urls.Source = "https://github.com/tox-dev/pyproject-api"
urls.Tracker = "https://github.com/tox-dev/pyproject-api/issues"

[dependency-groups]
dev = [
  { include-group = "docs" },
  { include-group = "lint" },
  { include-group = "pkg-meta" },
  { include-group = "test" },
  { include-group = "type" },
]
test = [
  "covdefaults>=2.3",
  "pytest>=9.1.1",
  "pytest-cov>=7.1",
  "pytest-mock>=3.16",
  "setuptools>=84",
]
type = [
  "ty<0.0.25,>=0.0.24",
  { include-group = "docs" },
  { include-group = "test" },
]
docs = [
  "furo>=2025.12.19",
  "sphinx-autodoc-typehints>=3.5.1",
  "sphinx-llm>=1.1",
  "sphinxcontrib-towncrier>=0.5.0a0",
]
build = [
  "cython>=3",
  "hatch-fancy-pypi-readme>=25.1",
  "hatch-vcs>=0.5",
  "hatchling>=1.32.4",
  "setuptools>=80",
]
lint = [
  "pre-commit-uv>=4.3",
]
pkg-meta = [
  "check-wheel-contents>=0.6.3",
  "twine>=7",
  "uv>=0.12.22",
]
release-news = [
  "release-creator>=4.4",
  "towncrier>=26.9",
]
release-notes = [
  "release-creator>=4.4",
]
release-prepare = [
  "prek>=0.5",
  "release-creator>=4.4",
  "towncrier>=26.9",
]

[tool.hatch]
version.source = "vcs"
metadata.hooks.fancy-pypi-readme.content-type = "text/markdown"
metadata.hooks.fancy-pypi-readme.fragments = [ { path = "README.md" } ]
build.hooks.vcs.version-file = "src/pyproject_api/_version.py"

[tool.uv]
dependency-groups.release-news = { requires-python = ">=3.15" }
dependency-groups.release-notes = { requires-python = ">=3.15" }
dependency-groups.release-prepare = { requires-python = ">=3.15" }

[tool.ruff]
line-length = 120
format.preview = true
format.docstring-code-line-length = 100
format.docstring-code-format = true
lint.select = [
  "ALL",
]
lint.ignore = [
  "any-type",                                  # Dynamically typed expressions
  "CPY",                                       # No copyright statements
  "DOC",                                       # no restructuredtext support
  "hardcoded-bind-all-interfaces",             # Possible binding to all interface
  "implicit-namespace-package",                # no implicit namespaces here
  "incorrect-blank-line-before-class",         # `one-blank-line-before-class` (D203) and `no-blank-line-before-class` (D211) are incompatible
  "missing-trailing-comma",                    # Conflict with formatter
  "multi-line-summary-first-line",             # `multi-line-summary-first-line` (D212) and `multi-line-summary-second-line` (D213) are incompatible
  "single-line-implicit-string-concatenation", # Conflict with formatter
]
lint.per-file-ignores."src/pyproject_api/_backend.py" = [
  "ANN",
  "missing-required-import",
  "print",
  "UP",
]
lint.per-file-ignores."src/pyproject_api/_backend.pyi" = [
  "blank-line-between-methods",
  "blank-lines-top-level",
]
lint.per-file-ignores."tests/**/*.py" = [
  "assert",                               # asserts allowed in tests
  "D",                                    # don't care about documentation in tests
  "FBT",                                  # don't care about booleans as positional arguments in tests
  "implicit-namespace-package",           # no implicit namespace
  "import-private-name",                  # private imports
  "magic-value-comparison",               # Magic value used in comparison, consider replacing with a constant variable
  "subprocess-without-shell-equals-true", # `subprocess` call: check for execution of untrusted input
  "too-many-arguments",                   # too many positional arguments
  "too-many-positional-arguments",        # too many positional arguments
]
lint.isort = { known-first-party = [
  "pyproject_api",
], required-imports = [
  "from __future__ import annotations",
] }
lint.preview = true

[tool.codespell]
builtin = "clear,usage,en-GB_to_en-US"
write-changes = true
count = true

[tool.pyproject-fmt]
max_supported_python = "3.15"

[tool.ty]
environment.python-version = "3.15"

[tool.coverage]
run.parallel = true
run.plugins = [
  "covdefaults",
]
run.patch = [ "subprocess" ]
paths.source = [
  "src",
  ".tox*/*/lib/python*/site-packages",
  ".tox*/pypy*/site-packages",
  ".tox*\\*\\Lib\\site-packages",
  "*/src",
  "*\\src",
]
report.omit = []
html.show_contexts = true
html.skip_covered = false

[tool.towncrier]
name = "pyproject-api"
directory = "docs/changelog.d"
filename = "docs/changelog.rst"
template = "docs/changelog.d/template.jinja2"
title_format = false
issue_format = ""
type = [
  { directory = "feature", name = "Added", showcontent = true },
  { directory = "change", name = "Changes", showcontent = true },
  { directory = "bugfix", name = "Fixed", showcontent = true },
  { directory = "doc", name = "Documentation", showcontent = true },
  { directory = "breaking", name = "Breaking changes", showcontent = true },
  { directory = "security", name = "Security", showcontent = true },
  { directory = "performance", name = "Performance", showcontent = true },
  { directory = "deprecation", name = "Deprecated", showcontent = true },
  { directory = "removal", name = "Removed", showcontent = true },
  { directory = "packaging", name = "Packaging", showcontent = true },
]

[tool.nab]
mode = "universal"
base-group = "project-runtime"
uploaded-prior-to = "P7D"
decision-order = "stable"
matrix.python = ">=3.15,<3.16"
matrix.platforms = [ "linux_x86_64" ]
# release-creator 4.4.0 needs a seven-day cutoff exception.
# expires 2026-11-09
packages.release-creator.uploaded-prior-to = 2026-11-02T21:45:00Z