tox.ini

# Tox reference:
# https://tox.wiki/en/stable/user_guide.html
# https://tox.wiki/en/stable/config.html

[tox]
requires =
    tox>=4
env_list = type, py{310}

[testenv]
description = run unit tests
deps =
    pytest~=7.4
    pytest-sugar~=0.9
    pytest-asyncio~=0.23
	mypy~=1.7
	types-requests~=2.31
	sphinx~=7.2.6
	myst-parser~=2.0.0
	sphinx-autodoc2~=0.5.0
	pydata-sphinx-theme~=0.14.4
	sphinx-autodoc-typehints~=1.25.2
	build~=1.0.3
	types-toml~=0.10.2
setenv =
    PYTHONPATH=src:tests
commands =
    pytest --tb=short -vv {posargs}
    # https://docs.pytest.org/en/7.1.x/how-to/output.html

[testenv:type]
description = run type checks
commands =
    mypy --strict --namespace-packages src tests

[testenv:dev]
description = run development commands
commands =
    mypy --strict --namespace-packages src tests
    {posargs}

[testenv:doc]
description = build the documentation
commands =
    sphinx-build -M html doc/src/ doc/build/

[testenv:build]
description = build the distribution archive into the dist folder
commands =
	python3 -m build