enpaul/tox-poetry-installer
1
0
Fork 0
mirror of https://github.com/enpaul/tox-poetry-installer.git synced 2025-11-04 07:46:06 +00:00
Code Issues Projects Releases Wiki Activity

Add basic usage instructions

Browse Source 
Add badges
This commit is contained in:
Ethan Paul
2020-09-23 20:42:27 -04:00
parent dc826df191
commit 417747c332
1 changed files with 41 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
README.md
View File

@@ -1,11 +1,49 @@
# tox-poetry-installer
A [Tox](https://tox.readthedocs.io/en/latest/) plugin for installing Tox environment
![image](https://img.shields.io/pypi/l/tox-poetry-installer)
![image](https://img.shields.io/pypi/v/tox-poetry-installer)
![image](https://img.shields.io/pypi/pyversions/tox-poetry-installer)
A [Tox](https://tox.readthedocs.io/en/latest/) plugin for installing test environment
dependencies using [Poetry](https://python-poetry.org/) from the Poetry lockfile.
⚠️ **This project is a very, very early prototype and should not be used in any production
capacity.**
⚠️ **This project is an early prototype and should not be used in any production capacity.**
## Usage
1. Install the plugin from PyPI:
```
poetry add tox-poetry-installer --dev
```
2. Remove all version specifications from the environment dependencies in `tox.ini`:
```ini
# This...
[testenv]
description = My cool test environment
deps =
requests >=2.19,<3.0
toml == 0.10.0
pytest >=5.4
# ...becomes this:
[testenv]
description = My cool test environment
deps =
requests
toml
pytest
```
3. Run Tox and force recreating environments:
```
poetry run tox --recreate
```
4. 💸 Profit 💸
## Why would I use this?