https://github.com/un-def/tox-pyenv-redux

A tox Python discovery plugin for pyenv–installed interpreters
https://github.com/un-def/tox-pyenv-redux

pyenv tox virtualenv

Last synced: 23 days ago
JSON representation

A tox Python discovery plugin for pyenv–installed interpreters

• Host: GitHub
• URL: https://github.com/un-def/tox-pyenv-redux
• Owner: un-def
• License: mit
• Created: 2022-01-13T12:26:55.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2024-05-16T05:16:26.000Z (6 months ago)
• Last Synced: 2024-10-10T16:26:40.453Z (27 days ago)
• Topics: pyenv, tox, virtualenv
• Language: Python
• Homepage:
• Size: 19.5 KB
• Stars: 5
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# tox-pyenv-redux

![GitHub License](https://img.shields.io/github/license/un-def/tox-pyenv-redux?style=flat-square)

![PyPI - Python Version](https://img.shields.io/pypi/pyversions/tox-pyenv-redux?style=flat-square)

![PyPI - Version](https://img.shields.io/pypi/v/tox-pyenv-redux?style=flat-square)

![PyPI - Downloads](https://img.shields.io/pypi/dm/tox-pyenv-redux?style=flat-square)

![GitHub Repo stars](https://img.shields.io/github/stars/un-def/tox-pyenv-redux?style=flat-square)

A [tox][tox] Python discovery plugin for [pyenv][pyenv]–installed interpreters

## Compatibility

* For legacy versions of tox (0.x—3.x), use tox-pyenv-redux 0.x (`tox-pyenv-redux < 1`). These versions do not rely on [virtualenv-pyenv][virtualenv-pyenv] and **DO NOT** support the `pyenv_discovery` setting.

* For the current version of tox (4.x), use tox-pyenv-redux 1.x (`tox-pyenv-redux >= 1, < 2`). These versions delegate the discovery job to [virtualenv-pyenv][virtualenv-pyenv].

## Installation

```shell

pip install tox-pyenv-redux

```

## Usage

The plugin is enabled by default and configured to use the default discovery [operation mode][virtualenv-pyenv-docs-operation-mode]. To change the mode or disable the plugin, set the `pyenv_discovery` environment setting to one of the following values:

* One of the [operation modes][virtualenv-pyenv-docs-operation-mode] (e.g., `fallback`) to use the specific operation mode. `pyenv_discovery = fallback` is equivalent to `export VIRTUALENV_DISCOVERY=pyenv-fallback`.

* `default` to use the default operation mode. This is the default value. `pyenv_discovery = default` (or no setting) is equivalent to `export VIRTUALENV_DISCOVERY=pyenv`.

* `off` to disable the plugin. The plugin will not touch the `VIRTUALENV_DISCOVERY` environment variable, but the [virtualenv-pyenv][virtualenv-pyenv] discovery can still be in effect if virtualenv is already configured to use it (via the `VIRTUALENV_DISCOVERY` environment variable or the `discovery` config setting).

## Examples

* Set the `fallback` operation mode via a config file:

  ```ini

  [tox]

  min_version = 4.0

  requires = tox-pyenv-redux

  [testenv]

  pyenv_discovery = fallback

  deps = pytest

  commands = pytest {posargs}

  ```

* Disable the plugin via command line arguments:

  ```shell

  tox run -x testenv.pyenv_discovery=off

  ```

[tox]: https://tox.wiki/

[pyenv]: https://github.com/pyenv/pyenv

[virtualenv-pyenv]: https://github.com/un-def/virtualenv-pyenv

[virtualenv-pyenv-docs-operation-mode]: https://github.com/un-def/virtualenv-pyenv/blob/master/README.md#operation-mode