Metadata-Version: 2.1
Name: tox-envlist
Version: 0.1.0
Summary: Allows selection of a different tox envlist.
Home-page: https://github.com/domdfcoding/tox-envlist
Author: Dominic Davis-Foster
Author-email: dominic@davis-foster.co.uk
License: MIT License
Project-URL: Documentation, https://tox-envlist.readthedocs.io
Project-URL: Issue_Tracker, https://github.com/domdfcoding/tox-envlist/issues
Project-URL: Source_Code, https://github.com/domdfcoding/tox-envlist
Platform: Windows
Platform: macOS
Platform: Linux
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Typing :: Typed
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
Provides-Extra: all
License-File: LICENSE

############
tox-envlist
############

.. start short_desc

**Allows selection of a different tox envlist.**

.. end short_desc


.. start shields

.. list-table::
	:stub-columns: 1
	:widths: 10 90

	* - Tests
	  - |travis| |actions_windows| |actions_macos| |codefactor|
	* - PyPI
	  - |pypi-version| |supported-versions| |supported-implementations| |wheel|
	* - Activity
	  - |commits-latest| |commits-since| |maintained|
	* - Other
	  - |license| |language| |requires| |pre_commit|



.. |travis| image:: https://img.shields.io/travis/com/domdfcoding/tox-envlist/master?logo=travis
	:target: https://travis-ci.com/domdfcoding/tox-envlist
	:alt: Travis Build Status

.. |actions_windows| image:: https://github.com/domdfcoding/tox-envlist/workflows/Windows%20Tests/badge.svg
	:target: https://github.com/domdfcoding/tox-envlist/actions?query=workflow%3A%22Windows+Tests%22
	:alt: Windows Tests Status

.. |actions_macos| image:: https://github.com/domdfcoding/tox-envlist/workflows/macOS%20Tests/badge.svg
	:target: https://github.com/domdfcoding/tox-envlist/actions?query=workflow%3A%22macOS+Tests%22
	:alt: macOS Tests Status

.. |requires| image:: https://requires.io/github/domdfcoding/tox-envlist/requirements.svg?branch=master
	:target: https://requires.io/github/domdfcoding/tox-envlist/requirements/?branch=master
	:alt: Requirements Status

.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/domdfcoding/tox-envlist?logo=codefactor
	:target: https://www.codefactor.io/repository/github/domdfcoding/tox-envlist
	:alt: CodeFactor Grade

.. |pypi-version| image:: https://img.shields.io/pypi/v/tox-envlist
	:target: https://pypi.org/project/tox-envlist/
	:alt: PyPI - Package Version

.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/tox-envlist?logo=python&logoColor=white
	:target: https://pypi.org/project/tox-envlist/
	:alt: PyPI - Supported Python Versions

.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/tox-envlist
	:target: https://pypi.org/project/tox-envlist/
	:alt: PyPI - Supported Implementations

.. |wheel| image:: https://img.shields.io/pypi/wheel/tox-envlist
	:target: https://pypi.org/project/tox-envlist/
	:alt: PyPI - Wheel

.. |license| image:: https://img.shields.io/github/license/domdfcoding/tox-envlist
	:target: https://github.com/domdfcoding/tox-envlist/blob/master/LICENSE
	:alt: License

.. |language| image:: https://img.shields.io/github/languages/top/domdfcoding/tox-envlist
	:alt: GitHub top language

.. |commits-since| image:: https://img.shields.io/github/commits-since/domdfcoding/tox-envlist/v0.1.0
	:target: https://github.com/domdfcoding/tox-envlist/pulse
	:alt: GitHub commits since tagged version

.. |commits-latest| image:: https://img.shields.io/github/last-commit/domdfcoding/tox-envlist
	:target: https://github.com/domdfcoding/tox-envlist/commit/master
	:alt: GitHub last commit

.. |maintained| image:: https://img.shields.io/maintenance/yes/2020
	:alt: Maintenance

.. |pre_commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
	:target: https://github.com/pre-commit/pre-commit
	:alt: pre-commit

.. end shields


Configuration
----------------

In your ``tox.ini`` file, add the following:

.. code-block:: ini

	[envlists]
	test = py36, py37, py38
	qa = mypy,lint
	cov = py36,coverage

This will configure three envlists:

* **test**, which runs the environments ``py36``, ``py37`` and ``py38``
* **qa**, which runs the environments ``mypy`` and ``lint``
* **cov**, which runs the environments ``py36`` and ``coverage``

You are free to customise these envlists and add new ones.


Usage
-------

Run tox using the ``-n`` / ``--envlist-name [name]`` option, where ``name`` is the name of the envlist.


Installation
--------------

.. start installation

``tox-envlist`` can be installed from PyPI.

To install with ``pip``:

.. code-block:: bash

	$ python -m pip install tox-envlist

.. end installation
