tox.ini

[tox]
isolated_build = true
envlist = py3, py3-black, py3-mypy, py3-pylint, py3-bandit, py3-isort, py3-docs

[testenv]
description = Run the tests.
deps =
    atoml
    typer[all]
    pytest
    pytest-cov
    pytest-srcpaths
commands =
    pytest --cov

[testenv:py3-black]
description = Check if files formatted correctly.
deps =
    atoml
    typer[all]
    black
commands =
    black --check --diff .

[testenv:py3-mypy]
description = Verify the types of the python files.
deps =
    atoml
    typer[all]
    mypy
commands =
    mypy .

[testenv:py3-pylint]
description = Lint files for code quality issues.
deps =
    atoml
    typer[all]
    pylint
commands =
    pylint src tests

[testenv:py3-bandit]
description = Check code for security issues.
deps =
    atoml
    typer[all]
    bandit[toml]
commands =
    bandit --configfile ./pyproject.toml --recursive src tests

[testenv:py3-isort]
description = Check imports are sorted.
deps =
    atoml
    typer[all]
    isort
commands =
    isort --check-only .

[testenv:py3-docs]
description = Use Sphinx and Myst-Parser to test generate the documentation html.
deps =
    atoml
    typer[all]
    sphinx
    myst-parser
commands =
    sphinx-build -d "{toxworkdir}/docs_cached" docs/source "{toxworkdir}/docs_dist" -bhtml {posargs}
    python -c 'import pathlib; print("documentation available under file://" + str((pathlib.Path("{toxworkdir}") / "docs_dist" / "index.html").absolute()))'