Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pglass/tox-pip-version
A tox plugin to select your pip version
https://github.com/pglass/tox-pip-version
Last synced: about 2 months ago
JSON representation
A tox plugin to select your pip version
- Host: GitHub
- URL: https://github.com/pglass/tox-pip-version
- Owner: pglass
- License: mit
- Created: 2019-01-23T20:58:53.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2021-09-24T09:05:45.000Z (over 3 years ago)
- Last Synced: 2024-09-25T15:38:31.849Z (3 months ago)
- Language: Python
- Size: 41 KB
- Stars: 4
- Watchers: 3
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.com/pglass/tox-pip-version)
Overview
--------
This is a tox plugin that preinstalls a specific version of pip in each tox
environment.
```bash
pip install tox-pip-version
```
This works around the default behavior of tox/virtualenv that always installs
the latest version pip. It is an improvment over the `VIRTUALENV_NO_DOWNLOAD=1`
option that does not install the latest version, but could result in usage of
an outdated version of pip.
*Recommendation*: Do not pin the pip version long term. You get more stable
repeatable builds, but at the cost of using an outdated (possibly vulnerable)
package. This should be used as a temporary fix for breakages in upstream pip,
or in conjunction with a regular process to update the version pin.
*Note*: This relies on an [unstable tox plugin interface](
https://tox.readthedocs.io/en/latest/plugins.html#tox.hookspecs.tox_testenv_create).
You may experience breakage with new tox versions. If you do, please feel
free to [report the issue](https://github.com/pglass/tox-pip-version/issues/new)
on Github.
### Usage
Install the package and include `pip_version` in your tox.ini
```tox
[testenv]
pip_version = pip==19.0.1
```
Or, set the `TOX_PIP_VERSION` environment variable,
```bash
export TOX_PIP_VERSION=18.1
tox
```
The plugin will install that version of pip into the tox-created virtualenv,
just after tox creates the virtualenv, but before dependencies are installed.
The `pip_version` within tox.ini, if present, is always used over the
environment variable.
If neither `pip_version` or `TOX_PIP_VERSION` is present, the plugin does
nothing.
### Version Sets
Version sets/ranges are supported, enabling installation of a version of pip
matching a set of specifiers. There are two basic formats: a plain version
number, or the package name with optional [PEP440-compatible](
https://www.python.org/dev/peps/pep-0440/#version-specifiers) version
specifiers.
| tox.ini | effective pip command |
| ---------------------------- | ---------------------------- |
| `pip_version = 19.0` | `pip install -U pip==19.0` |
| `pip_version = pip==19.0` | `pip install -U pip==19.0` |
| `pip_version = pip>=19.0` | `pip install -U pip>=19.0` |
| `pip_version = pip!=19,>18` | `pip install -U pip!=19,>18` |
| `pip_version = pip` | `pip install -U pip` |
| `pip_version = pip@git+https://github.com/pypa/pip@5eae3c9` | `pip install -U pip@git+https://github.com/pypa/pip@5eae3c9` |
### Tests
Use `make test` to run the tests, which includes linting and functional tests.
Each of the `tests/*` directories is a "feature" that needs testing. Each
feature sub-directory contains a tox.ini file that sets pip version in a
particular way, and then uses a tox command to check the correct pip version
was installed.