tox.ini

[tox]
minversion = 3.8
envlist = lint,types,py{38,39,310,311,312},integration,docs
isolated_build = True

[testenv]
deps =
    pretend
    pytest
    pytest-socket
    build
    coverage
    # Needed on 3.12 and newer due to setuptools not being pre-installed
    # in fresh venvs.
    # See: https://github.com/python/cpython/issues/95299
    setuptools
passenv =
    PYTEST_ADDOPTS
setenv =
    HOME=/tmp/nonexistent
commands =
    python -m coverage run -m pytest {posargs}
    python -m coverage html
    python -m coverage report --skip-covered --show-missing --fail-under 97

[testenv:integration]
deps =
    {[testenv]deps}
    pytest-rerunfailures
    pytest-services
    devpi-server
    devpi
    pypiserver
passenv =
    PYTEST_ADDOPTS
commands =
    pytest -r aR tests/test_integration.py {posargs}

[testenv:docs]
deps =
    -rdocs/requirements.txt
allowlist_externals =
    sh
commands =
    sphinx-build -W --keep-going -b html -d {envtmpdir}/doctrees docs docs/_build/html
    sphinx-build -W --keep-going -b doctest -d {envtmpdir}/doctrees docs docs/_build/html
    doc8 docs README.rst --ignore-path docs/_build/html
    sphinx-build -W --keep-going -b linkcheck -d {envtmpdir}/doctrees docs docs/_build/linkcheck
    sh -c "python -m twine check --strict $TOX_PACKAGE"

[testenv:watch-docs]
deps =
    -rdocs/requirements.txt
    sphinx-autobuild
commands =
    sphinx-autobuild -b html -d {envtmpdir}/doctrees \
        --watch twine \
        {posargs:--host 127.0.0.1} \
        docs docs/_build/html

[testenv:format]
skip_install = True
deps =
    isort
    black
commands =
    isort twine/ tests/
    black twine/ tests/

[testenv:lint]
skip_install = True
deps =
    {[testenv:format]deps}
    flake8
    flake8-docstrings
commands =
    isort --check-only --diff twine/ tests/
    black --check --diff twine/ tests/
    flake8 twine/ tests/

[testenv:types]
deps =
    mypy
    # required for report generation. 5.2.1 is forbidden due to an observed
    # broken wheel on CPython 3.8:
    # https://bugs.launchpad.net/lxml/+bug/2064158
    lxml >= 5.2.0, != 5.2.1
    # required for more thorough type declarations
    keyring >= 22.3
    # consider replacing with `mypy --install-types` when
    # https://github.com/python/mypy/issues/10600 is resolved
    types-requests
commands =
    pip list
    mypy --html-report mypy --txt-report mypy {posargs:twine}
    python -c 'with open("mypy/index.txt") as f: print(f.read())'

[testenv:changelog]
basepython = python3
deps =
    towncrier
commands =
    towncrier build {posargs}


# Usage:
#  tox -e create-changelog-item -- [additional arguments] {filename}.{bugfix,feature,doc,removal,misc}
[testenv:create-changelog-item]
basepython = python3
skip_install = True
deps = towncrier
commands =
    towncrier create --config pyproject.toml {posargs}

[testenv:release]
# specify Python 3 to use platform's default Python 3
basepython = python3
deps =
    build
passenv =
    TWINE_PASSWORD
    TWINE_REPOSITORY
setenv =
    TWINE_USERNAME = {env:TWINE_USERNAME:__token__}
commands =
    python -c "import shutil; shutil.rmtree('dist', ignore_errors=True)"
    python -m build
    python -m twine upload dist/*

[testenv:dev]
envdir = {posargs:venv}
recreate = True
deps =
    {[testenv]deps}
    {[testenv:integration]deps}
    {[testenv:format]deps}
    {[testenv:lint]deps}
    {[testenv:types]deps}
download = True
usedevelop = True
commands =
    python -c 'import sys; print(sys.executable)'
    python --version