| Name | tox-pyenv-redux JSON |
| Version |
1.1.0
JSON |
| download |
| home_page | |
| Summary | A tox Python discovery plugin for pyenv-installed interpreters |
| upload_time | 2024-01-17 09:48:45 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | MIT |
| keywords |
tox
pyenv
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# tox-pyenv-redux
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
Raw data
{
"_id": null,
"home_page": "",
"name": "tox-pyenv-redux",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "tox,pyenv",
"author": "",
"author_email": "Dmitry Meyer <me@undef.im>",
"download_url": "https://files.pythonhosted.org/packages/5b/e6/a87b66a3c60ea73379db356487864bf16b2297a5b2ff33d44e3458b591a2/tox-pyenv-redux-1.1.0.tar.gz",
"platform": null,
"description": "# tox-pyenv-redux\n\nA [tox][tox] Python discovery plugin for [pyenv][pyenv]\u2013installed interpreters\n\n## Compatibility\n\n* For legacy versions of tox (0.x\u20143.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.\n* 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].\n\n## Installation\n\n```shell\npip install tox-pyenv-redux\n```\n\n## Usage\n\nThe 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:\n\n* 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`.\n* `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`.\n* `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).\n\n## Examples\n\n* Set the `fallback` operation mode via a config file:\n\n ```ini\n [tox]\n min_version = 4.0\n requires = tox-pyenv-redux\n\n [testenv]\n pyenv_discovery = fallback\n deps = pytest\n commands = pytest {posargs}\n ```\n\n* Disable the plugin via command line arguments:\n\n ```shell\n tox run -x testenv.pyenv_discovery=off\n ```\n\n\n[tox]: https://tox.wiki/\n[pyenv]: https://github.com/pyenv/pyenv\n[virtualenv-pyenv]: https://github.com/un-def/virtualenv-pyenv\n[virtualenv-pyenv-docs-operation-mode]: https://github.com/un-def/virtualenv-pyenv/blob/master/README.md#operation-mode\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A tox Python discovery plugin for pyenv-installed interpreters",
"version": "1.1.0",
"project_urls": {
"Changelog": "https://github.com/un-def/tox-pyenv-redux/releases",
"Homepage": "https://github.com/un-def/tox-pyenv-redux",
"Issues": "https://github.com/un-def/tox-pyenv-redux/issues",
"Repository": "https://github.com/un-def/tox-pyenv-redux.git"
},
"split_keywords": [
"tox",
"pyenv"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d37a5b70608df1200f4e1f031b138025b5560e25f17080067c6a2fd4e4895c47",
"md5": "95ef436c86ea9c317aefd44692562f5e",
"sha256": "cf45ca73634163bd04fa41f2ba6c6852d6099afa8324ddbe4ad06a467c7ea730"
},
"downloads": -1,
"filename": "tox_pyenv_redux-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "95ef436c86ea9c317aefd44692562f5e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 4616,
"upload_time": "2024-01-17T09:48:39",
"upload_time_iso_8601": "2024-01-17T09:48:39.397128Z",
"url": "https://files.pythonhosted.org/packages/d3/7a/5b70608df1200f4e1f031b138025b5560e25f17080067c6a2fd4e4895c47/tox_pyenv_redux-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5be6a87b66a3c60ea73379db356487864bf16b2297a5b2ff33d44e3458b591a2",
"md5": "b01b07266491c8aac38f17b63e1d8b7b",
"sha256": "bbfe47a8cdeadcb4f96762f18220946714a76cb53ab285b5ae8e83e3ea617b3e"
},
"downloads": -1,
"filename": "tox-pyenv-redux-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "b01b07266491c8aac38f17b63e1d8b7b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 5055,
"upload_time": "2024-01-17T09:48:45",
"upload_time_iso_8601": "2024-01-17T09:48:45.976919Z",
"url": "https://files.pythonhosted.org/packages/5b/e6/a87b66a3c60ea73379db356487864bf16b2297a5b2ff33d44e3458b591a2/tox-pyenv-redux-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-17 09:48:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "un-def",
"github_project": "tox-pyenv-redux",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "tox-pyenv-redux"
}
