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

Update contributor, devel, and roadmap documentation

Browse Source
This commit is contained in:
Ethan Paul
2020-12-05 18:04:14 -05:00
parent 0ad5fb7219
commit 1941a103d3
1 changed files with 20 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@@ -479,9 +479,11 @@ the [`--require-poetry`](#--require-poetry) option.
## Developing ## Developing
This project requires a developer to have Poetry version 1.0+ installed on their workstation, see This project requires Poetry version 1.0+ on the development workstation, see
the [installation instructions here](https://python-poetry.org/docs/#installation). the [installation instructions here](https://python-poetry.org/docs/#installation).
Local environment setup instructions:
```bash ```bash
# Clone the repository... # Clone the repository...
# ...over HTTPS # ...over HTTPS
@@ -491,7 +493,7 @@ git clone git@github.com:enpaul/tox-poetry-installer.git
# Create a the local project virtual environment and install dependencies # Create a the local project virtual environment and install dependencies
cd tox-poetry-installer cd tox-poetry-installer
poetry install poetry install -E poetry
# Install pre-commit hooks # Install pre-commit hooks
poetry run pre-commit install poetry run pre-commit install
@@ -500,11 +502,18 @@ poetry run pre-commit install
poetry run tox poetry run tox
``` ```
**NOTE:** Because the pre-commit hooks require dependencies in the Poetry environment it
is recommend to [launch an environment shell](https://python-poetry.org/docs/cli/#shell)
when developing the project. Alternatively, many `git` commands will need to be run from
outside of the environment shell by prefacing the command with
[`poetry run`](https://python-poetry.org/docs/cli/#run).
## Contributing ## Contributing
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, v2](CODE_OF_CONDUCT.md)
([external link](https://www.contributor-covenant.org/version/2/0/code_of_conduct/)).
The `devel` branch has the latest (potentially unstable) changes. The The `devel` branch has the latest (potentially unstable) changes. The
[tagged versions](https://github.com/enpaul/tox-poetry-installer/releases) correspond to the [tagged versions](https://github.com/enpaul/tox-poetry-installer/releases) correspond to the
@@ -537,24 +546,25 @@ for usage in production environments.
Tox configuration option ([#4](https://github.com/enpaul/tox-poetry-installer/issues/4)) Tox configuration option ([#4](https://github.com/enpaul/tox-poetry-installer/issues/4))
- [X] Add per-environment Tox configuration option to fall back to default installation - [X] Add per-environment Tox configuration option to fall back to default installation
backend. backend.
- [ ] Add warnings when an unsupported Tox configuration option is detected while using the - [ ] ~Add warnings when an unsupported Tox configuration option is detected while using the
Poetry backend. ([#5](https://github.com/enpaul/tox-poetry-installer/issues/5)) Poetry backend. ([#5](https://github.com/enpaul/tox-poetry-installer/issues/5))~
- [X] Add trivial tests to ensure the project metadata is consistent between the pyproject.toml - [X] Add trivial tests to ensure the project metadata is consistent between the pyproject.toml
and the module constants. and the module constants.
- [X] Update to use [poetry-core](https://github.com/python-poetry/poetry-core) and - [X] Update to use [poetry-core](https://github.com/python-poetry/poetry-core) and
improve robustness of the Tox and Poetry module imports improve robustness of the Tox and Poetry module imports
to avoid potentially breaking API changes in upstream packages. ([#2](https://github.com/enpaul/tox-poetry-installer/issues/2)) to avoid potentially breaking API changes in upstream packages. ([#2](https://github.com/enpaul/tox-poetry-installer/issues/2))
- [ ] Find and implement a way to mitigate the [UNSAFE_DEPENDENCIES issue](https://github.com/python-poetry/poetry/issues/1584) in Poetry. - [ ] ~Find and implement a way to mitigate the [UNSAFE_DEPENDENCIES issue](https://github.com/python-poetry/poetry/issues/1584) in Poetry.
([#6](https://github.com/enpaul/tox-poetry-installer/issues/6)) ([#6](https://github.com/enpaul/tox-poetry-installer/issues/6))~
- [ ] Fix logging to make proper use of Tox's logging reporter infrastructure ([#3](https://github.com/enpaul/tox-poetry-installer/issues/3)) - [X] Fix logging to make proper use of Tox's logging reporter infrastructure ([#3](https://github.com/enpaul/tox-poetry-installer/issues/3))
- [X] Add configuration option for installing all dev-dependencies to a testenv ([#14](https://github.com/enpaul/tox-poetry-installer/issues/14)) - [X] Add configuration option for installing all dev-dependencies to a testenv ([#14](https://github.com/enpaul/tox-poetry-installer/issues/14))
### Path to Stable ### Path to Stable
Everything in Beta plus... Everything in Beta plus...
- [ ] Add tests for each feature version of Tox between 2.3 and 3.20 - [ ] Add comprehensive unit tests
- [ ] Add tests for Python-3.6, 3.7, and 3.8 - [ ] Add tests for each feature version of Tox between 3.0 and 3.20
- [ ] Add tests for Python-3.6, 3.7, 3.8, and 3.9
- [X] Add Github Actions based CI - [X] Add Github Actions based CI
- [ ] Add CI for CPython, PyPy, and Conda - [ ] Add CI for CPython, PyPy, and Conda
- [ ] Add CI for Linux and Windows - [ ] Add CI for Linux and Windows