tox.ini

[tox]
envlist =
    checks
    py3{7,8,9,10,11,12,13}
isolated_build = True
skip_missing_interpreters = True

[gh-actions]
python =
    # setuptools >=62 needs Python >=3.7
    3.7: py37,checks
    3.8: py38
    3.9: py39
    3.10: py310
    3.11: py311
    3.12: py312
    3.13: py313


[testenv]
description = Run test suite for {basepython}
skip_install = true
allowlist_externals = make
commands = pytest {posargs:}
deps =
    pytest
    pytest-cov
    setuptools>=62.0
    setuptools-scm
setenv =
    PIP_DISABLE_PIP_VERSION_CHECK = 1
downloads = true


[testenv:mypy]
description = Check code style
basepython = python3
deps = mypy
commands = mypy {posargs:src}


[testenv:docstrings]
description = Check for PEP257 compatible docstrings
basepython = python3
deps = docformatter
commands =
	docformatter --check --diff {posargs:src}


[testenv:checks]
description = Run code style checks
basepython = python3
deps =
    ruff
commands =
    ruff check


[testenv:docs]
description = Build HTML documentation
basepython = python3
deps = -r{toxinidir}/docs/requirements.txt
skip_install = true
allowlist_externals =
    make
    echo
    uvx
commands =
    uvx make -C docs html
commands_post =
    echo "Find the HTML documentation at file://{toxinidir}/docs/_build/html/index.html"


[testenv:man]
description = Build the manpage
basepython = python3
deps = sphinx
skip_install = true
commands = make -C docs man


[testenv:prepare-dist]
description = Prepare for TestPyPI
basepython = python3
deps =
    twine
    build
commands =
    # Same as python3 -m build
    pyproject-build
    twine check dist/*


[testenv:changelog]
description = Run towncrier to check, build, or create the CHANGELOG.rst
basepython = python3
skip_install = true
deps =
    git+https://github.com/twisted/towncrier.git
commands =
    towncrier {posargs:build --draft}