tox.ini

# This is the configuration for the tox-gh-actions plugin for GitHub Actions
#   https://github.com/ymyzk/tox-gh-actions
# This section is not needed if not using GitHub Actions for CI.
[gh-actions]
python =
    3.8: py38
    3.9: py39, fmt-check, lint, type-check, docs
    3.10: py310

[tox]
# These are the default environments that will be run
#   when `tox` is run without arguments.
envlist =
    fmt-check
    lint
    type-check
    py{38,39,310}
    docs
skip_missing_interpreters = true

# Activate isolated build environment. tox will use a virtual environment
# to build a source distribution from the source tree. For build tools and
# arguments use the pyproject.toml file as specified in PEP-517 and PEP-518.
isolated_build = true

[testenv]
deps =
    -r{toxinidir}/requirements/requirements.txt
    -r{toxinidir}/requirements/dev-requirements.txt
commands =
    # Use -bb to enable BytesWarnings as error to catch str/bytes misuse.
    # Use -Werror to treat warnings as errors.
    {envpython} -bb -Werror -m pytest \
        --cov=pathpy --cov-report=html --cov-report=term {posargs}

[testenv:type-check]
skip_install = true
deps =
    # It is important to install the main project requirements, as some
    # packages many contain inline type hints (PEP 561) that mypy will use.
    -r{toxinidir}/requirements/requirements.txt
    -r{toxinidir}/requirements/dev-requirements.txt
commands =
    mypy src tests

[testenv:lint]
skip_install = true
deps =
    -r{toxinidir}/requirements/dev-requirements.txt
commands =
    flake8

[testenv:fmt]
skip_install = true
deps =
    -r{toxinidir}/requirements/dev-requirements.txt
commands =
    isort .
    black .

[testenv:fmt-check]
skip_install = true
deps =
    -r{toxinidir}/requirements/dev-requirements.txt
commands =
    isort --check .
    black --check .

[testenv:docs]
skip_install = true
deps =
    -r{toxinidir}/requirements/dev-requirements.txt
commands =
    sphinx-build -b html {toxinidir}/docs/ {toxinidir}/docs/_build/html/

[testenv:docs-github-pages]
skip_install = true
commands =
    # See: https://squidfunk.github.io/mkdocs-material/publishing-your-site/
    mkdocs gh-deploy --force

[testenv:build]
skip_install = true
deps =
    build
commands =
    {envpython} -m build

[testenv:upload]
skip_install = true
deps =
    twine
commands =
    {envpython} -m twine upload {toxinidir}/dist/*

[testenv:licenses]
skip_install = true
recreate = true
deps =
    -r{toxinidir}/requirements/requirements.txt
    pip-licenses
commands =
    pip-licenses {posargs}