{"author":"Yusuke Miyazaki","author_email":"miyazaki.dev@gmail.com","bugtrack_url":null,"classifiers":["Development Status :: 5 - Production/Stable","Framework :: tox","Intended Audience :: Developers","License :: OSI Approved :: MIT License","Operating System :: OS Independent","Programming Language :: Python :: 3","Programming Language :: Python :: 3 :: Only","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.13","Programming Language :: Python :: 3.7","Programming Language :: Python :: 3.8","Programming Language :: Python :: 3.9","Programming Language :: Python :: Implementation :: CPython","Programming Language :: Python :: Implementation :: PyPy","Topic :: Software Development :: Libraries","Topic :: Software Development :: Testing","Topic :: Utilities","Typing :: Typed"],"description":"# tox-gh-actions \n\n[![PyPI version](https://badge.fury.io/py/tox-gh-actions.svg)](https://badge.fury.io/py/tox-gh-actions)\n[![PyPI Supported Python Versions](https://img.shields.io/pypi/pyversions/tox-gh-actions.svg)](https://pypi.python.org/pypi/tox-gh-actions/)\n[![GitHub Actions (Tests)](https://github.com/ymyzk/tox-gh-actions/actions/workflows/tests.yml/badge.svg)](https://github.com/ymyzk/tox-gh-actions/actions/workflows/tests.yml)\n[![codecov](https://codecov.io/gh/ymyzk/tox-gh-actions/branch/master/graph/badge.svg?token=7RWjRk2LkX)](https://codecov.io/gh/ymyzk/tox-gh-actions)\n\n**tox-gh-actions** is a tox plugin which helps running tox on GitHub Actions\nwith multiple different Python versions on multiple workers in parallel.\nThis project is inspired by [tox-travis](https://github.com/tox-dev/tox-travis).\n\n## Versions and Compatibility\nCurrently, tox-gh-actions supports both tox 3 and 4, but users need to install the appropriate version by following the table below.\n\n| tox | tox-gh-actions | Supported by tox-gh-actions | Branch |\n|-----|----------------|-----------------------------|-----------------------------------------------------------|\n| 4.x | 3.x | Yes (stable) | [master](https://github.com/ymyzk/tox-gh-actions) |\n| 3.x | 2.x | Yes (stable) | [tox3](https://github.com/ymyzk/tox-gh-actions/tree/tox3) |\n\n- [Features](#features)\n- [Usage](#usage)\n- [Examples](#examples)\n - [Basic Example](#basic-example)\n - [tox-gh-actions Configuration](#tox-gh-actions-configuration)\n - [Workflow Configuration](#workflow-configuration)\n - [Advanced Examples](#advanced-examples)\n - [Factor-Conditional Settings: Python Version](#factor-conditional-settings-python-version)\n - [Factor-Conditional Settings: Environment Variable](#factor-conditional-settings-environment-variable)\n - [tox requires](#tox-requires)\n - [Overriding Environments to Run](#overriding-environments-to-run)\n- [Versioning](#versioning)\n- [Understanding Behavior of tox-gh-actions](#understanding-behavior-of-tox-gh-actions)\n - [How tox-gh-actions Works](#how-tox-gh-actions-works)\n - [Logging](#logging)\n\n## Features\nWhen running tox on GitHub Actions, tox-gh-actions\n* detects which environment to run based on configurations and\n* provides utilities such as [grouping log lines](https://github.com/actions/toolkit/blob/main/docs/commands.md#group-and-ungroup-log-lines).\n\n## Usage\n1. Add configurations under `[gh-actions]` section along with tox's configuration.\n - It will be `pyproject.toml`, `tox.ini`, or `setup.cfg`. See [tox's documentation](https://tox.wiki/en/latest/config.html) for more details.\n\n2. Install `tox-gh-actions` package in the GitHub Actions workflow before running `tox` command.\n\n## Examples\n### Basic Example\nThe following configuration will create 4 jobs when running the workflow on GitHub Actions.\n- On Python 3.7 job, tox runs `py37` environment\n- On Python 3.8 job, tox runs `py38` environment\n- On Python 3.9 job, tox runs `py39` environment\n- On Python 3.10 job, tox runs `py310` and `mypy` environments\n\n#### tox-gh-actions Configuration\nAdd `[gh-actions]` section to the same file as tox's configuration.\n\nIf you're using `tox.ini`:\n```ini\n[tox]\nenvlist = py37, py38, py39, py310, mypy\n\n[gh-actions]\npython =\n 3.7: py37\n 3.8: py38\n 3.9: py39\n 3.10: py310, mypy\n\n[testenv]\n...\n```\n\nIf you're using `setup.cfg`:\n```ini\n[tox:tox]\nenvlist = py37, py38, py39, py310, mypy\n\n[gh-actions]\npython =\n 3.7: py37\n 3.8: py38\n 3.9: py39\n 3.10: py310, mypy\n\n[testenv]\n...\n```\n\nIf you're using `pyproject.toml`:\n```toml\n[tool.tox]\nlegacy_tox_ini = \"\"\"\n[tox]\nenvlist = py37, py38, py39, py310, mypy\n\n[gh-actions]\npython =\n 3.7: py37\n 3.8: py38\n 3.9: py39\n 3.10: py310, mypy\n\n[testenv]\n\"\"\"\n```\n\n#### Workflow Configuration\n`.github/workflows/.yml`:\n```yaml\nname: Python package\n\non:\n - push\n - pull_request\n\njobs:\n build:\n runs-on: ubuntu-latest\n strategy:\n matrix:\n python-version: ['3.7', '3.8', '3.9', '3.10']\n\n steps:\n - uses: actions/checkout@v3\n - name: Set up Python ${{ matrix.python-version }}\n uses: actions/setup-python@v4\n with:\n python-version: ${{ matrix.python-version }}\n - name: Install dependencies\n run: |\n python -m pip install --upgrade pip\n python -m pip install tox tox-gh-actions\n - name: Test with tox\n run: tox\n```\n\n### Advanced Examples\n#### Factor-Conditional Settings: Python Version\nThe following configuration will create 2 jobs when running the workflow on GitHub Actions.\n- On Python 3.7 job, tox runs `py37-django22` and `py37-django32` environments\n- On Python 3.8 job, tox runs `py38-django32` environment\n\n`tox.ini`:\n```ini\n[tox]\nenvlist = py37-django{22,32}, py38-django32\n\n[gh-actions]\npython =\n 3.7: py37\n 3.8: py38\n\n[testenv]\n...\n```\n\nWhen using pre-release versions of Python, please do not specify `-beta` or `-dev` in `tox.ini`.\n\n`.github/workflows/.yml`:\n```yaml\n...\njobs:\n build:\n strategy:\n matrix:\n python-version: [3.9, 3.10.0-beta.3]\n...\n```\n\n`tox.ini`:\n```ini\n[tox]\nenvlist = py39, py310\n\n[gh-actions]\npython =\n 3.9: py39\n 3.10: py310\n # The following won't work\n # 3.10-beta.3: py310\n # 3.10-dev: py310\n\n[testenv]\n...\n```\n\nPyPy is also supported in the `python` configuration key.\nSupport of Pyston is experimental and not tested by our CI.\n\n `tox.ini`:\n```ini\n[tox]\nenvlist = py37, py38, pypy3, pyston38\n\n[gh-actions]\npython =\n 3.7: py37\n 3.8: py38, mypy\n pypy-3.7: pypy3\n pyston-3.8: pyston38\n\n[testenv]\n...\n\n[testenv:pyston38]\nbasepython = pyston38\n```\n\nYou can also specify without minor versions in the `python` configuration key.\n\n`tox.ini`:\n```ini\n[tox]\nenvlist = py3, pypy3\n\n[gh-actions]\npython =\n 3: py3, mypy\n pypy-3: pypy3\n\n[testenv]\n...\n```\n\nIf there are multiple matching Python versions in the configuration, only the most precise one is used.\nFor example, if you are running CPython 3.8 and `gh-actions.python` has both `3` and `3.8`,\ntox-gh-actions gets factors only from the key `3.8`.\n\n_Changed in 3.0_: `pypy3` is not supported in the configuration anymore. Please use `pypy-3` instead.\n\n#### Factor-Conditional Settings: Environment Variable\nYou can also use environment variable to decide which environment to run.\nThe following is an example to install different dependency based on platform.\nIt will create 9 jobs when running the workflow on GitHub Actions.\n- On Python 3.8/ubuntu-latest job, tox runs `py38-linux` environment\n- On Python 3.9/ubuntu-latest job, tox runs `py39-linux` environment\n- and so on.\n\n`.github/workflows/.yml`:\n```yaml\nname: Python package\n\non:\n - push\n - pull_request\n\njobs:\n build:\n runs-on: ${{ matrix.platform }}\n strategy:\n matrix:\n platform: [ubuntu-latest, macos-latest, windows-latest]\n python-version: ['3.8', '3.9', '3.10']\n\n steps:\n - uses: actions/checkout@v3\n - name: Set up Python ${{ matrix.python-version }}\n uses: actions/setup-python@v4\n with:\n python-version: ${{ matrix.python-version }}\n - name: Install dependencies\n run: |\n python -m pip install --upgrade pip\n python -m pip install tox tox-gh-actions\n - name: Test with tox\n run: tox\n env:\n PLATFORM: ${{ matrix.platform }}\n```\n\n`tox.ini`:\n```ini\n[tox]\nenvlist = py{38,39,310}-{linux,macos,windows}\n\n[gh-actions]\npython =\n 3.8: py38\n 3.9: py39\n 3.10: py310\n\n[gh-actions:env]\nPLATFORM =\n ubuntu-latest: linux\n macos-latest: macos\n windows-latest: windows\n\n[testenv]\ndeps =\n \n linux: \n macos: \n windows: \n...\n```\n\n_Changed in 3.0_: Environment variables should not use lowercase letters.\nBecause of the limitation in tox's configuration loading API,\ntox-gh-actions always convert keys in `[gh-actions:env]` to uppercase.\n\n#### tox requires\nIf your project uses [tox's `requires` configuration](https://tox.wiki/en/latest/config.html#conf-requires),\nyou must add `tox-gh-actions` to the `requires` configuration as well. Otherwise, tox-gh-actions won't be loaded as a tox plugin.\n\n```ini\n[tox]\nrequires =\n tox-conda\n tox-gh-actions\n```\n\n### Overriding Environments to Run\n_Changed in 2.0_: When a list of environments to run is specified explicitly via `-e` option or `TOXENV` environment variable ([tox's help](https://tox.wiki/en/latest/cli_interface.html#tox-run--e)),\ntox-gh-actions respects the given environments and simply runs the given environments without enforcing its configuration.\n\nBefore 2.0, tox-gh-actions was always enforcing its configuration even when a list of environments is given explicitly.\n\n## Versioning\nThis project follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) and uses a format of major.minor.patch (X.Y.Z).\nThe major version (X) will be incremented when we make backward incompatible changes to a public API.\nThe public API of this project is the configuration of tox-gh-actions.\nThe major version can be also incremented when we require a new version of tox.\n\nThis project tries not to introduce backward incompatibles changes as much as possible so that users don't need to\nupdate their project's configuration too frequently.\n\ntox-gh-actions 3.x may drop support of unsupported Python 3.y versions in the future without bumping its major version.\n\n## Understanding Behavior of tox-gh-actions\n### How tox-gh-actions Works\nSee [ARCHITECTURE.md](./ARCHITECTURE.md) for more details.\n\n### Logging\ntox-gh-actions writes log messages using the standard `logging` module.\nThis is handy for understanding behavior of tox-gh-actions and for debugging tox-gh-actions.\nTo see the log messages, please run `tox -vv`.\n","description_content_type":"text/markdown","docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":"https://github.com/ymyzk/tox-gh-actions","keywords":"virtual, environments, isolated, testing","license":"MIT","license_expression":null,"license_files":null,"maintainer":"Yusuke Miyazaki","maintainer_email":"miyazaki.dev@gmail.com","name":"tox-gh-actions","package_url":"https://pypi.org/project/tox-gh-actions/","platform":"any","project_url":"https://pypi.org/project/tox-gh-actions/","project_urls":{"Homepage":"https://github.com/ymyzk/tox-gh-actions","Source":"https://github.com/ymyzk/tox-gh-actions","Tracker":"https://github.com/ymyzk/tox-gh-actions/issues"},"provides_extra":["testing"],"release_url":"https://pypi.org/project/tox-gh-actions/3.3.0/","requires_dist":["tox<5,>=4","black; platform_python_implementation == \"CPython\" and extra == \"testing\"","devpi-process; extra == \"testing\"","flake8<7,>=6; python_version >= \"3.8\" and extra == \"testing\"","mypy; platform_python_implementation == \"CPython\" and extra == \"testing\"","pytest>=7; extra == \"testing\"","pytest-cov>=4; extra == \"testing\"","pytest-mock>=3; extra == \"testing\"","pytest-randomly>=3; extra == \"testing\""],"requires_python":">=3.7","summary":"Seamless integration of tox into GitHub Actions","version":"3.3.0","yanked":false,"yanked_reason":null}

Dependency	Optional
tox	false
black	true
devpi-process	true
flake8	true
mypy	true
pytest	true
pytest-cov	true
pytest-mock	true
pytest-randomly	true

Package search

tox-gh-actions

project_urls

Dependencies

All package metadata

Releases