diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..eba53b6 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,129 @@ + +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +[INSERT CONTACT METHOD]. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. diff --git a/README.md b/README.md index 06e1bd1..0e2ad95 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,26 @@ # tox-poetry-installer +A plugin for [Tox](https://tox.readthedocs.io/en/latest/) that allows test environment +dependencies to be installed using [Poetry](https://python-poetry.org/) using its lockfile. + ⚠️ **This project is alpha software and should not be used in a production capacity** ⚠️ ![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 lockfile. - -**Contents** +**Documentation** * [Installation and Usage](#installation-and-usage) * [Limitations](#limitations) -* [What problem does this solve?](#what-problems-does-this-solve)/Why would I use this? +* [What problem does this solve?](#what-problems-does-this-solve) (Why would I use this?) * [Developing](#developing) * [Contributing](#contributing) * [Roadmap](#roadmap) * [Path to Beta](#path-to-beta) * [Path to Stable](#path-to-stable) -Related reading: +Related resources: * [Poetry Python Project Manager](https://python-poetry.org/) * [Tox Automation Project](https://tox.readthedocs.io/en/latest/) * [Tox plugins](https://tox.readthedocs.io/en/latest/plugins.html) @@ -53,7 +53,7 @@ deps = pytest ``` -3. Run Tox and force recreating environments: +3. Run Tox with the `--recreate` flag to rebuild the test environments: ``` poetry run tox --recreate @@ -81,7 +81,7 @@ poetry run tox --recreate dependencies are installed from the lockfile and alternative versions cannot be specified in the Tox configuration. -## What problem does this solve? +## What problems does this solve? [The point of using a lockfile is to create reproducable builds](https://docs.gradle.org/current/userguide/dependency_locking.html). One of the main points of Tox is to [allow a Python package to be built and tested in multiple environments](https://tox.readthedocs.io/en/latest/#what-is-tox). However, in the Tox configuration file the dependencies are specified with @@ -150,3 +150,17 @@ poetry run pre-commit install # Run tests and static analysis poetry run tox ``` + +## Contributing + +All project contributors and participants are expected to adhere to the +[Contributor Covenant Code of Conduct, Version 2](CODE_OF_CONDUCT.md). + +* 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). +* To report a security concern or code of conduct violation, please contact the project author + directly at **ethan dot paul at enp dot one**. +* To submit an update, please + [fork the repository](https://docs.github.com/en/enterprise/2.20/user/github/getting-started-with-github/fork-a-repo) + and + [open a pull request](https://github.com/enpaul/tox-poetry-installer/compare). diff --git a/pyproject.toml b/pyproject.toml index 4ee0bdd..374c3ea 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -2,7 +2,7 @@ name = "tox-poetry-installer" version = "0.1.0" license = "MIT" -authors = ["Ethan Paul "] +authors = ["Ethan Paul <24588726+enpaul@users.noreply.github.com>"] description = "Tox plugin to install Tox environment dependencies using the Poetry backend and lockfile" repository = "https://github.com/enpaul/tox-poetry-installer/" packages = [{include = "tox_poetry_installer.py"}]