tox.ini

# Tox (http://tox.testrun.org/) is a tool for running tests
# in multiple virtualenvs. This configuration file will run the
# test suite on all supported python versions. To use it, "pip install tox"
# and then run "tox" from this directory.

[tox]
# To use a PEP 517 build-backend you are required to configure tox to use an isolated_build:
# https://tox.readthedocs.io/en/latest/example/package.html
isolated_build = True

# These environments are run in order if you just use `tox`:
envlist =
    # always keep coverage-clean first
    coverage-clean
    # code linters/stylers
    lint
    # manifest
    # pyroma
    flake8
    mypy
    # documentation linters/checkers
    # doc8
    docstr-coverage
    # docs-test
    # the actual tests
    ; py
    # always keep coverage-report last
    # coverage-report

; [testenv]
# Runs on the "tests" directory by default, or passes the positional
# arguments from `tox -e py <posargs_1> ... <posargs_n>
; whitelist_externals =
;     poetry
; commands =
;     poetry run pytest
; commands =
;     coverage run -p -m pytest --durations=20 {posargs:tests}
;     coverage combine
;     coverage xml
; deps =
;     pytest
;     coverage


[testenv:coverage-clean]
deps = coverage
skip_install = true
commands = coverage erase

[testenv:lint]
deps =
    black
    isort
skip_install = true
commands =
    black src/ tests/
    isort src/ tests/
description = Run linters.

[testenv:doclint]
deps =
    rstfmt
skip_install = true
commands =
    rstfmt docs/source/
description = Run documentation linters.

# [testenv:manifest]
# deps = check-manifest
# skip_install = true
# commands = check-manifest
# description = Check that the MANIFEST.in is written properly and give feedback on how to fix it.

[testenv:flake8]
skip_install = true
deps =
    darglint
    flake8<5.0.0
    flake8-black
    flake8-bandit
    flake8-bugbear
    flake8-colors
    flake8-docstrings
    flake8-isort
    flake8-print
    pydocstyle
commands =
    flake8 src/ tests/
description = Run the flake8 tool with several plugins (bandit, docstrings, import order, pep8 naming).

#########################
# Flake8 Configuration  #
# (.flake8)             #
#########################
[flake8]
ignore =
    DAR101 # Missing parameter(s) in Docstring: - with_git_hash
    DAR201 # Missing "Returns" in Docstring: - return
    DAR301 # Missing "Yields" in Docstring: - yield
    DAR401 # Missing exception(s) in Raises section: -r ValueError
    E111 # indentation is not a multiple of 4
    T201 # print found.
max-line-length = 100

# [testenv:pyroma]
# deps =
#     pygments
#     pyroma
# skip_install = true
# commands = pyroma --min=10 .
# description = Run the pyroma tool to check the package friendliness of the project.

[testenv:mypy]
deps = mypy
skip_install = true
commands = mypy --install-types --non-interactive --ignore-missing-imports --implicit-optional src/
description = Run the mypy tool to check static typing on the project.

# [testenv:doc8]
# skip_install = true
# deps =
#     sphinx
#     doc8
# commands =
#     doc8 docs/source/
# description = Run the doc8 tool to check the style of the RST files in the project docs.

[testenv:docstr-coverage]
skip_install = true
deps =
    docstr-coverage
commands =
    docstr-coverage src/ tests/ --skip-private --skip-magic
description = Run the docstr-coverage tool to check documentation coverage

; [testenv:docs]
; description = Build the documentation locally.
; extras =
;     docs
;     # You might need to add additional extras if your documentation covers it
; commands =
;     python -m sphinx -W -b html -d docs/build/doctrees docs/source docs/build/html

; [testenv:docs-test]
; description = Test building the documentation in an isolated environment.
; changedir = docs
; deps =
;     sphinx
;     sphinx_autodoc_typehints
;     sphinx_automodapi
;     sphinx_click
; extras =
;     {[testenv:docs]extras}
; commands =
;     mkdir -p {envtmpdir}
;     cp -r source {envtmpdir}/source
;     python -m sphinx -W -b html     -d {envtmpdir}/build/doctrees {envtmpdir}/source {envtmpdir}/build/html
;     python -m sphinx -W -b coverage -d {envtmpdir}/build/doctrees {envtmpdir}/source {envtmpdir}/build/coverage
;     cat {envtmpdir}/build/coverage/c.txt
;     cat {envtmpdir}/build/coverage/python.txt
; whitelist_externals =
;     /bin/cp
;     /bin/cat
;     /bin/mkdir
;     # for compatibility on GitHub actions
;     /usr/bin/cp
;     /usr/bin/cat
;     /usr/bin/mkdir

; [testenv:coverage-report]
; deps = coverage
; skip_install = true
; commands =
;     coverage combine
;     coverage report

####################
# Deployment tools #
####################

# [testenv:bumpversion]
# commands = bumpversion {posargs}
# skip_install = true
# passenv = HOME
# deps =
#     bumpversion

[testenv:build]
skip_install = true
deps =
    wheel
    build
commands =
    python -m build --sdist --wheel --no-isolation

# [testenv:release]
# description = Release the code to PyPI so users can pip install it
# skip_install = true
# deps =
#     {[testenv:build]deps}
#     twine >= 1.5.0
# commands =
#     {[testenv:build]commands}
#     twine upload --skip-existing dist/*

# [testenv:testrelease]
# description = Release the code to the test PyPI site
# skip_install = true
# deps =
#     {[testenv:build]deps}
#     twine >= 1.5.0
# commands =
#     {[testenv:build]commands}
#     twine upload --skip-existing --repository-url https://test.pypi.org/simple/ dist/*

# [testenv:finish]
# skip_install = true
# passenv =
#     HOME
#     TWINE_USERNAME
#     TWINE_PASSWORD
# deps =
#     {[testenv:release]deps}
#     bump2version
# commands =
#     bump2version release --tag
#     {[testenv:release]commands}
#     git push --tags
#     bump2version patch
#     git push
# whitelist_externals =
#     /usr/bin/git