tox.ini

# Copyright 2024 J.P. Morgan Chase & Co.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
# specific language governing permissions and limitations under the License.


# Tox virtual environment manager for testing and quality assurance

[tox]
envlist = py39, py310, py311, py312, linting, docs
isolated_build = True
# Developers may not have all Python versions
skip_missing_interpreters = true

[gh-actions]
# Mapping from GitHub Actions Python versions to Tox environments
python =
  3.9: py39
  3.10: py310
  3.11: py311, linting, docs
  3.12: py312

[testenv]
# Base test environment

extras =
  testing
commands =
  python -m pytest --cov={envsitepackagesdir}{/}active_label

[testenv:dev]
# Scratch environment in .venv/

envdir = {toxinidir}{/}.venv
usedevelop = true
extras =
  linting
  testing
commands =

[testenv:linting]
# Linting tools environment

extras =
  linting
commands =
  python -m pip list
  python -m isort --diff --check .
  python -m black --diff --color --check .
  python -m interrogate src/
  python -m flake8 .
  python -m mypy --install-types --non-interactive --package=active_label

[testenv:docs]
# Sphinx documentation generation environment

extras =
  docs
commands =
  # Command exactly as executed on readthedocs.org. See https://readthedocs.org/projects/active-label/builds/.
  python -m sphinx -T -E -W --keep-going -b html -d {toxinidir}{/}docs{/}_build{/}doctrees -D language=en {toxinidir}{/}docs {toxinidir}{/}docs{/}_build{/}html

[testenv:py312]
# Overrides for Python 3.12 (dev) test environment
# TODO: remove entire section once Python 3.12 is released (October 2023)

# Allow tests for alpha/beta Python release to fail. Show warnings only.
ignore_outcome = true