tox.ini

[tox]
env_list =
    check-style
    test-xdist
    py{38,39,310,311,312}-test{,-alldeps,-devdeps}{,-cov}
    build_docs
    linkcheck
    codestyle
requires =
    setuptools >= 30.3.0
    pip >= 19.3.1

isolated_build = tru
# This is included for testing of the template. You can remove it safely.
; skip_missing_interpreters = True

[testenv:check-style]
description = check code style with ruff
change_dir = .
skip_install = true
deps =
    ruff
commands =
    ruff .

[testenv]
# tox environments are constructed 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
    oldestdeps: with the oldest supported version of key dependencies
    cov: and test coverage
    xdist: in parallel

# Pass through the following environment variables which may be needed for the CI
pass_env =
    HOME
    WINDIR
    LC_ALL
    LC_CTYPE
    CC
    CI
    TRAVIS

# Suppress display of matplotlib plots generated during docs build
set_env =
    MPLBACKEND=agg

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

deps =
    cov: pytest-cov
    oldestdeps: minimum_dependencies
    xdist: pytest-xdist

# The following indicates which extras_require from setup.cfg will be installed
extras =
    test

commands_pre =
    oldestdeps: minimum_dependencies heasarc_retrieve_pipeline --filename requirements-min.txt
    ; pip install -e .
    pip freeze

commands =
    !cov: pytest --pyargs heasarc_retrieve_pipeline {toxinidir}/docs {posargs} --remote-data
    cov: pytest --pyargs heasarc_retrieve_pipeline {toxinidir}/docs {posargs} --cov-config={toxinidir}/pyproject.toml  --cov heasarc_retrieve_pipeline --cov-report xml:coverage.xml --cov-report term-missing --remote-data
    cov: coverage xml -o {toxinidir}/coverage.xml
    ; xdist: -n auto

[testenv:check-build]
description = check PEP517 package build
change_dir = .
skip_install = true
deps =
    build
    twine
commands =
    python -m build --sdist .
    twine check dist/*

[testenv:build-docs]
description = invoke sphinx-build to build the HTML docs
extras =
    docs
commands =
    sphinx-build -W docs docs/_build {posargs}