tox.ini

# this file is *not* meant to cover or endorse the use of tox or pytest or
# testing in general,
#
#  It's meant to show the use of:
#
#  - check-manifest
#     confirm items checked into vcs are in your sdist
#  - readme_renderer (when using a ReStructuredText README)
#     confirms your long_description will render correctly on PyPI.
#
#  and also to help confirm pull requests to this project.

[tox]
envlist = coverage,py{38,39,310,311}
requires =
    tox>=4

[testenv]
description = run tests
deps =
    -r{toxinidir}/requirements/test.txt
commands =
    flake8 .
    mypy
    coverage run -p -m pytest -Wd {posargs}

[testenv:check-release]
description = check release
skip_install = true
deps =
    -r{toxinidir}/requirements/check-release.txt
commands =
    check-manifest
    python -m build
    python -m twine check dist/*

[testenv:coverage]
description = generate coverage report
depends = py{38,39,310,311}
skip_install = true
commands =
    coverage combine
    coverage report --skip-covered
    coverage html
    coverage json
parallel_show_output = true

[testenv:dev]
description = used to create devenv with all dependencies installed
use_develop = true
deps =
    -r{toxinidir}/requirements/all.txt

[testenv:docs-build]
description = build docs
skip_install = true
deps =
    -r{toxinidir}/requirements/docs.txt
commands =
    mkdocs build

[testenv:docs-serve]
description = run docs development server
skip_install = true
deps =
    -r{toxinidir}/requirements/docs.txt
commands =
    mkdocs serve

[testenv:format]
description = run formatters
skip_install = true
deps =
    -r{toxinidir}/requirements/format.txt
commands =
    black .
    isort --profile black .

[testenv:update]
description = update dependencies
skip_install = true
deps =
    -r{toxinidir}/requirements/upgrade.txt
commands =
    pip-compile pyproject.toml --resolver=backtracking -qo requirements/all.txt --all-extras {posargs}
    pip-compile pyproject.toml --resolver=backtracking -qo requirements/check-release.txt --extra=check-release {posargs}
    pip-compile pyproject.toml --resolver=backtracking -qo requirements/docs.txt --extra=docs {posargs}
    pip-compile pyproject.toml --resolver=backtracking -qo requirements/format.txt --extra=format {posargs}
    pip-compile pyproject.toml --resolver=backtracking -qo requirements/requirements.txt {posargs}
    pip-compile pyproject.toml --resolver=backtracking -qo requirements/test.txt --extra=test {posargs}
    pip-compile pyproject.toml --resolver=backtracking -qo requirements/upgrade.txt --extra=upgrade {posargs}

[testenv:upgrade]
description = upgrade dependencies
skip_install = true
deps =
    -r{toxinidir}/requirements/upgrade.txt
commands =
    pip-compile pyproject.toml --resolver=backtracking -Uqo requirements/all.txt --all-extras {posargs}
    pip-compile pyproject.toml --resolver=backtracking -Uqo requirements/check-release.txt --extra=check-release {posargs}
    pip-compile pyproject.toml --resolver=backtracking -Uqo requirements/docs.txt --extra=docs {posargs}
    pip-compile pyproject.toml --resolver=backtracking -Uqo requirements/format.txt --extra=format {posargs}
    pip-compile pyproject.toml --resolver=backtracking -Uqo requirements/requirements.txt {posargs}
    pip-compile pyproject.toml --resolver=backtracking -Uqo requirements/test.txt --extra=test {posargs}
    pip-compile pyproject.toml --resolver=backtracking -Uqo requirements/upgrade.txt --extra=upgrade {posargs}

# https://github.com/ymyzk/tox-gh-actions
[gh-actions]
python =
    3.8: py38
    3.9: py39
    3.10: py310
    3.11: py311