tox.ini

[tox]
envlist =
    py{37,38,39,310,311}-test{,-oldestdeps,-alldeps,-basebanddev,-devdeps}{,-cov}
    build_docs
    codestyle
requires =
    setuptools >= 30.3.0
    pip >= 19.3.1
isolated_build = true

[testenv]

# Pass through the following environemnt variables which may be needed for the CI
passenv = HOME,WINDIR,LC_ALL,LC_CTYPE,CC,CI

# Run the tests in a temporary directory to make sure that we don't import
# this package from the source tree
changedir = .tmp/{envname}

# tox environments are constructued with so-called 'factors' (or terms)
# separated by hyphens, e.g. test-devdeps-cov. Lines below starting with factor:
# will only take effect if that factor is included in the environment name. To
# see a list of example environments that can be run, along with a description,
# run:
#
#     tox -l -v
#
description =
    run tests
    alldeps: with all optional dependencies
    basebanddev: with developer version of baseband
    devdeps: with the latest developer version of key dependencies
    oldestdeps: with the oldest supported version of key dependencies
    cov: and test coverage

# The following provides some specific pinnings for key packages
deps =

    oldestdeps: baseband==4.1.*
    oldestdeps: astropy==4.0.*
    oldestdeps: numpy==1.17.*

    basebanddev: git+https://github.com/mhvk/baseband.git#egg=baseband

    devdeps: git+https://github.com/numpy/numpy.git#egg=numpy
    devdeps: git+https://github.com/astropy/astropy.git#egg=astropy
    devdeps: git+https://github.com/mhvk/baseband.git#egg=baseband
    devdeps: git+https://github.com/nanograv/PINT.git#egg=pint-pulsar

# The following indicates which extras_require from setup.cfg will be installed
extras =
    test: test
    cov: cov
    alldeps: all
    basebanddev: io

commands =
    pip freeze
    !cov: pytest --pyargs baseband_tasks {toxinidir}/docs {posargs}
    cov: pytest --pyargs baseband_tasks {toxinidir}/docs --cov baseband_tasks --cov-config={toxinidir}/setup.cfg {posargs}
    cov: coverage xml -o {toxinidir}/coverage.xml

[testenv:build_docs]
changedir = docs
description = invoke sphinx-build to build the HTML docs
extras = docs
commands =
    pip freeze
    sphinx-build -W --keep-going -b html . _build/html

[testenv:linkcheck]
changedir = docs
description = check the links in the HTML docs
extras = docs
commands =
    pip freeze
    sphinx-build -W -b linkcheck . _build/html

[testenv:codestyle]
skip_install = true
changedir = .
description = check code style, e.g. with flake8
deps = flake8
commands = flake8 baseband_tasks --count