tox.ini

[tox]
min_version = 4.0
requires =
    setuptools >= 30.3.0
    pip >= 21.0.1
    tox-pypi-filter >= 0.14
envlist =
    py{310,311,312}
    py312-{devdeps,benchmarks,figure}
    py310-oldestdeps
    codestyle
    build_docs{,-notebooks}

[testenv]
pypi_filter = https://raw.githubusercontent.com/sunpy/sunpy/main/.test_package_pins.txt
allowlist_externals=
    /bin/sh
# 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}
description =
    run tests
    oldestdeps: with the oldest supported version of key dependencies
    devdeps: with the latest developer version of key dependencies
pass_env =
    # A variable to tell tests we are on a CI system
    CI
    # Custom compiler locations (such as ccache)
    CC
    # Location of locales (needed by sphinx on some systems)
    LOCALE_ARCHIVE
    # If the user has set a LC override we should follow it
    LC_ALL
set_env =
    MPLBACKEND = agg
    COLUMNS = 180
    devdeps: PIP_EXTRA_INDEX_URL = https://pypi.anaconda.org/astropy/simple https://pypi.anaconda.org/scientific-python-nightly-wheels/simple
deps =
    # For packages which publish nightly wheels this will pull the latest nightly
    devdeps: astropy>=0.0.dev0
    devdeps: numpy>=0.0.dev0
    devdeps: scipy>=0.0.dev0
    devdeps: matplotlib>=0.0.dev0
    devdeps: sunpy>=0.0.dev0
    devdeps: git+https://github.com/sunpy/ndcube
    devdeps: git+https://github.com/spacetelescope/gwcs
    devdeps: git+https://github.com/asdf-format/asdf
    devdeps: git+https://github.com/astropy/asdf-astropy
    devdeps: git+https://github.com/sunpy/mpl-animators
    # Autogenerate oldest dependencies from info in setup.cfg
    oldestdeps: minimum_dependencies
    figure-!devdeps: matplotlib==3.9.1
    figure-!devdeps: mpl-animators==1.1.1
    figure-!devdeps: astropy==6.1.1
    figure-!devdeps: ndcube==2.2.2
# The following indicates which extras_require will be installed
extras =
    tests
commands_pre =
    oldestdeps: minimum_dependencies dkist --filename requirements-min.txt
    oldestdeps: pip install -r requirements-min.txt cryptography<42 jsonschema==4.0.1
    figure: python -c "from dkist.data.sample import download_all_sample_data; download_all_sample_data()"
    pip freeze --all --no-input
commands =
    figure: /bin/sh -c "mkdir -p ./figure_test_images; python -c 'import matplotlib as mpl; print(mpl.ft2font.__file__, mpl.ft2font.__freetype_version__, mpl.ft2font.__freetype_build_type__)' > ./figure_test_images/figure_version_info.txt"
    figure: /bin/sh -c "pip freeze >> ./figure_test_images/figure_version_info.txt"
    figure: /bin/sh -c "cat ./figure_test_images/figure_version_info.txt"
    figure: python -c "import dkist.tests.helpers as h; print(h.get_hash_library_name())"
    # To amend the pytest command for different factors you can add a line
    # which starts with a factor like `online: --remote-data=any \`
    # If you have no factors which require different commands this is all you need:
    pytest \
    -vvv \
    -r fEs \
    --pyargs dkist \
    --cov-report=xml \
    --cov=dkist \
    --cov-config={toxinidir}/.coveragerc \
    {toxinidir}/docs \
    online: --remote-data=any \
    !benchmarks: --benchmark-skip \
    benchmarks: -m benchmark \
    benchmarks: --benchmark-autosave \
    figure: -m "mpl_image_compare" \
    figure: --mpl \
    figure: --remote-data=any \
    figure: --mpl-generate-summary=html \
    figure: --mpl-baseline-path=https://raw.githubusercontent.com/DKISTDC/dkist-figure-tests/main/figures/{envname}/ \
    oldestdeps: -o asdf_schema_tests_enabled=false \
    {posargs}

[testenv:codestyle]
pypi_filter =
skip_install = true
description = Run all style and file checks with pre-commit
deps =
    pre-commit
commands =
    pre-commit install-hooks
    pre-commit run --color always --all-files --show-diff-on-failure

[testenv:build_docs{,-notebooks}]
description = invoke sphinx-build to build the HTML docs
change_dir =
    docs
extras =
    docs
commands =
    pip freeze --all --no-input
    # Disable parallel here due to https://github.com/astropy/astropy/issues/14916
    sphinx-build \
    -j 1 \
    --color \
    -W \
    --keep-going \
    -b html \
    -d _build/.doctrees \
    . \
    _build/html \
    !notebooks: -D nb_execution_mode=off \
    {posargs}
    python -c 'import pathlib; print("Documentation available under file://\{0\}".format(pathlib.Path(r"{toxinidir}") / "docs" / "_build" / "index.html"))'