tox.ini

[base]
# set the python package name for use in other sections
name = argortqcpy

[tox]
# 3.1.0 required for ignore_basepython_conflict
minversion = 3.1.0

# always use the python version specified in the environment name
ignore_basepython_conflict = true

# set which envs are run when tox is used with no args (e.g. from PyCharm)
envlist = py36, build, docs, lint

[testenv]
extras = test
commands =
    # tox tests against the installed package, so we can't use the source path
    pytest \
        --cov {envsitepackagesdir}/{[base]name} \
        --cov-branch \
        --cov-report=term-missing \
        --cov-report=xml \
        -s \
        -v \
        {posargs:tests}

[testenv:lint]
deps =
    pylint
    pycodestyle
    pydocstyle
    black
    mypy
commands =
    black --line-length 120 --check --diff setup.py
    black --line-length 120 --check --diff docs/source/conf.py
    black --line-length 120 --check --diff {[base]name}
    pylint {[base]name}
    pycodestyle {[base]name}
    pydocstyle {[base]name}
    mypy {[base]name}
    black --line-length 120 --check --diff tests
    pylint tests
    pycodestyle tests
    pydocstyle tests
    mypy --allow-untyped-defs tests

[testenv:build]
skip_install = true
skipsdist = true
deps =
    wheel
    twine
commands =
    python setup.py clean --all --build-temp dist/
    python setup.py sdist bdist_wheel
    twine check dist/*

[testenv:docs]
extras = docs
changedir = docs
commands =
    # -W option fails on warning
    sphinx-build -M clean source build -W
    sphinx-build -M html source build -W

[testenv:format]
skip_install = true
skipsdist = true
deps =
    black
commands =
    black --line-length 120 setup.py
    black --line-length 120 docs/source/conf.py
    black --line-length 120 {[base]name}
    black --line-length 120 tests