enpaul/tox-poetry-installer
1
0
Fork 0
mirror of https://github.com/enpaul/tox-poetry-installer.git synced 2025-01-15 08:43:29 +00:00
Code Issues Projects Releases Wiki Activity

Misc documentation updates

Browse Source 
Fix inconsistent env naming in example ini snippets
Fix PS1 in demo commands to make it clearer what they are
Rename 'getting started' section to 'usage'
Add note about main branch and tag usage
This commit is contained in:
Ethan Paul 2020-09-27 14:21:19 -04:00
parent c481b7b0bb
commit fb1ac3b0de
No known key found for this signature in database
GPG Key ID: D0E2CBF1245E92BF
1 changed files with 17 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -12,7 +12,7 @@ dependencies to be installed using [Poetry](https://python-poetry.org/) using it
**Documentation** **Documentation**
* [Installation](#installation) * [Installation](#installation)
* [Getting Started](#getting-started) * [Usage](#usage)
* [Drawbacks](#drawbacks) * [Drawbacks](#drawbacks)
* [Why would I use this?](#why-would-i-use-this) (What problems does this solve?) * [Why would I use this?](#why-would-i-use-this) (What problems does this solve?)
* [Developing](#developing) * [Developing](#developing)
@ -32,13 +32,13 @@ Related resources:
Add the plugin as a development dependency a project using Poetry: Add the plugin as a development dependency a project using Poetry:
``` ```
#> poetry add tox-poetry-installer --dev ~ $: poetry add tox-poetry-installer --dev
``` ```
Confirm that the plugin is installed, and Tox recognizes it, by checking the Tox version: Confirm that the plugin is installed, and Tox recognizes it, by checking the Tox version:
``` ```
#> poetry run tox --version ~ $: poetry run tox --version
3.20.0 imported from .venv/lib64/python3.8/site-packages/tox/__init__.py 3.20.0 imported from .venv/lib64/python3.8/site-packages/tox/__init__.py
registered plugins: registered plugins:
tox-poetry-installer-0.2.0 at .venv/lib64/python3.8/site-packages/tox_poetry_installer.py tox-poetry-installer-0.2.0 at .venv/lib64/python3.8/site-packages/tox_poetry_installer.py
@ -49,11 +49,11 @@ same environment as Tox:
``` ```
# Calling the virtualenv's 'pip' binary directly will cause pip to install to that virtualenv # Calling the virtualenv's 'pip' binary directly will cause pip to install to that virtualenv
#> /path/to/my/automation/virtualenv/bin/pip install tox ~ $: /path/to/my/automation/virtualenv/bin/pip install tox
#> /path/to/my/automation/virtualenv/bin/pip install tox-poetry-installer ~ $: /path/to/my/automation/virtualenv/bin/pip install tox-poetry-installer
``` ```
## Getting Started ## Usage
After installing the plugin to a project, your Tox automation is already benefiting from the After installing the plugin to a project, your Tox automation is already benefiting from the
lockfile: when Tox installs your project package to one of your environments, all the dependencies lockfile: when Tox installs your project package to one of your environments, all the dependencies
@ -62,8 +62,8 @@ happens automatically and requires no configuration changes.
But what about the rest of your Tox environment dependencies? But what about the rest of your Tox environment dependencies?
Let's use an example `tox.ini` file with two environments: the main `testenv` for running our Let's use an example `tox.ini` file, below, that defines two environments: the main `testenv` for
tests and `testenv:check` for running some other helper checks: running the project tests and `testenv:check` for running some other helpful checks:
```ini ```ini
[tox] [tox]
@ -76,7 +76,7 @@ deps =
pytest == 5.3.0 pytest == 5.3.0
commands = ... commands = ...
[testenv:static] [testenv:check]
description = Static formatting and quality enforcement description = Static formatting and quality enforcement
deps = deps =
pylint >=2.4.4,<2.6.0 pylint >=2.4.4,<2.6.0
@ -85,13 +85,13 @@ deps =
commands = ... commands = ...
``` ```
Let's focus on the `testenv:static` environment first. In this project there's no reason that any Let's focus on the `testenv:check` environment first. In this project there's no reason that any
of these tools should be a different version than what a human developer is using when installing of these tools should be a different version than what a human developer is using when installing
from the lockfile. We can require that these dependencies be installed from the lockfile by adding from the lockfile. We can require that these dependencies be installed from the lockfile by adding
the option `require_locked_deps = true` to the environment config, but this will cause an error: the option `require_locked_deps = true` to the environment config, but this will cause an error:
```ini ```ini
[testenv:static] [testenv:check]
description = Static formatting and quality enforcement description = Static formatting and quality enforcement
require_locked_deps = true require_locked_deps = true
deps = deps =
@ -114,7 +114,7 @@ information it errors. We can fix this by simply removing all version specifiers
environment dependency list: environment dependency list:
```ini ```ini
[testenv:static] [testenv:check]
description = Static formatting and quality enforcement description = Static formatting and quality enforcement
require_locked_deps = true require_locked_deps = true
deps = deps =
@ -129,7 +129,7 @@ a new version then that updated version will be automatically installed when the
recreated. recreated.
Now let's look at the `testenv` environment. Let's make the same changes to the `testenv` Now let's look at the `testenv` environment. Let's make the same changes to the `testenv`
environment that we made to `testenv:static` above; remove the PyTest version and add environment that we made to `testenv:check` above; remove the PyTest version and add
`require_locked_deps = true`. Then imagine that we want to add a new (made up) tool the test `require_locked_deps = true`. Then imagine that we want to add a new (made up) tool the test
environment called `crash_override` to the environment: we can add `crash-override` as a dependency environment called `crash_override` to the environment: we can add `crash-override` as a dependency
of the test environment, but this will cause an error: of the test environment, but this will cause an error:
@ -361,6 +361,10 @@ poetry run tox
All project contributors and participants are expected to adhere to the All project contributors and participants are expected to adhere to the
[Contributor Covenant Code of Conduct, Version 2](CODE_OF_CONDUCT.md). [Contributor Covenant Code of Conduct, Version 2](CODE_OF_CONDUCT.md).
The `devel` branch has the latest (potentially unstable) changes. The
[tagged versions](https://github.com/enpaul/tox-poetry-installer/releases) correspond to the
releases on PyPI.
* To report a bug, request a feature, or ask for assistance, please * To report a bug, request a feature, or ask for assistance, please
[open an issue on the Github repository](https://github.com/enpaul/tox-poetry-installer/issues/new). [open an issue on the Github repository](https://github.com/enpaul/tox-poetry-installer/issues/new).
* To report a security concern or code of conduct violation, please contact the project author * To report a security concern or code of conduct violation, please contact the project author