Skip to main content

A tox plugin to install extras directly into a testenv

Project description

tox-extras

A tox plugin to install extras directly from pyproject.toml into a testenv

Quick start

Install it with

pip install tox-extras

Add it to requires in the [tox] section of your tox.ini

[tox]
min_version = 4.0
requires = tox-extras

Say you have a lint extra in pyproject.toml which you want to use in a testenv:

[project.optional-dependencies]
lint = ["black==23.3.0"]

In your tox.ini testenv sections you can write

[testenv:lintonly]
skip_sdist = true
skip_install = true
tox_extras = lint
commands = black --check example.py

and this will install all deps from the "lint" extra into the testenv without installing your package or any of its deps.

Motivation

Tox has built-in support for installing extras using the extras testenv config option, but this does not work when combined with skip_install.

This plugin adds a tox_extras option to the tox EnvConfigSet and installs the extras named in this option into the testenv directly from pyproject.toml without installing the package.

This would be especially valuable when we want to use pyproject.toml as a single source of truth for our build, install, and dev dependencies (so putting deps in tox.ini is out of the question), but at the same time we don't want to "waste time" building and installing our package (and maybe its deps in a first-time tox run, e.g., in CI) into a testenv that only runs a linter (and therefore does not depend at all on the package or any deps being installed).

See https://github.com/tox-dev/tox/issues/2301 for the corresponding feature request in tox.

See https://github.com/pypa/pip/issues/4783#issuecomment-343771222 for commentary about the possible advantages of keeping all dependencies in one place.

Limitations

This plugin explicitly parses pyproject.toml, so it will not work with projects that define extras in setup.py.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tox-extras-0.0.2.tar.gz (5.8 kB view details)

Uploaded Source

Built Distribution

tox_extras-0.0.2-py3-none-any.whl (4.3 kB view details)

Uploaded Python 3

File details

Details for the file tox-extras-0.0.2.tar.gz.

File metadata

  • Download URL: tox-extras-0.0.2.tar.gz
  • Upload date:
  • Size: 5.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for tox-extras-0.0.2.tar.gz
Algorithm Hash digest
SHA256 4461d5614344c2db72daf69bd6488b1ebeb8bb858506fcb43318ab3b0b1fc458
MD5 00154da9db83621a5ff5614b17001c16
BLAKE2b-256 265f3ee0c8a398dc064024605d80c15689bb3bb6cc15db7505ab438a4d9355ef

See more details on using hashes here.

File details

Details for the file tox_extras-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: tox_extras-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 4.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for tox_extras-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2731d5a482bd904f4502d78008607f80d5d8217b75763f3614eea53072910864
MD5 a8c7a7d42a6ceba261b8214487e60b68
BLAKE2b-256 3921a9c12999e630a28062565daf43dec4e053b08083e5d853ae70ce956a4fc9

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page