This section is intended for those who wish to contribute to this project. You can contribute in many ways:
- Reporting problems of any kind: things not working correctly, wrong/missing docs, etc.
- Solving existing issues.
- Creating PRs with code/docs/etc.
- Forking this project to create your own.
- Becoming a project maintainer.
You have to agree with the following Code of Conduct.
Code of conduct¶
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.
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
Start your local dev environment by activating the virtualenv. I recommend using pyenv, but whatever suits your needs is fine.
Don't worry about Python versions, use any of the supported ones. The pipeline will test the rest of them.
After that, install dependencies with
poetry install --remove-untracked.
All dependencies are managed by poetry. Project related dependencies are handled at the project's root, whereas docs related dependencies are treated separately in the
Splitting dependencies like this is a bit annoying, but it was necessary due to an incompatibility between
flake8 (due to
importlib-metadata). And it turns out to be not that bad, given that now we can create a proper requirements file for Read The Docs.
Therefore, you will need two virtualenv: one for the project, and one for the docs. However, if you use
invoke then this is taken care for you, and you don't have to worry about the docs venv: it will be created automatically as needed. If you need to interact with said virtualenv, make sure to activate it when entering the docs subdir (poetry should take care of this for you, too).
Write your code. Then create a changelog fragment using
scriv create with a short description of your changes in the corresponding category (added, changed, fixed, etc.).
You must include the necessary docstrings and unit tests so that coverage remains 100%.
It is preferred to contribute with short, reviewable commits rather than huge changes.
Finally, the following commands must succeed locally:
inv reformat: format code using YAPF.
inv lint: static analysis for compliance of PEP8, PEP257, PEP287 and many more.
inv tests: run the tests' battery.
inv safety: run a security analysis over dependencies using
You can alternatively run
inv commit to run all the above and commit afterwards.
If the linter complains about code too complex, run
inv cc -c (or the long expression
inv cyclomatic-complexity --complex) for more information.
Working under Stackless¶
You can install and run this package in Stackless without issues but if you are using Stackless to contribute to this project, you probably noticed that running
inv tests fails with a segmentation fault: I have no idea what causes it, but it is related to
pytest. The solution is to run
pytest --no-cov (or
inv tests --no-coverage), and letting the pipeline show the coverage for you.
Releasing new versions¶
Once everything is ready for release, follow these steps:
- Create a new release branch from
git flow release start <M.m.p>
version(you can use
poetry version major|minor|patchaccordingly to one-up said version part).
__version__ = '<M.m.p>'.
- Collect changelog fragments:
- Edit the changelog to properly indicate the version.
- Copy the edition to the changelog in the docs.
- If necessary, write the upgrade guide in the docs.
- Commit, push branch and create MR to
main. A CI job will publish the package to Test PyPy as a prerelease. If something went wrong, fix, commit and push again; the CI job will change the release number and publish it again.
- Merge into
mainand create MR to
- Merge into
develop, create and push signed tag:
git tag -s <M.m.p>. A CI job will publish the package to PyPi.
- Create release in Gitlab and properly sign packages.
To sign a tag, run
inv sign-tag <tag name>. To sign a file, use
inv sign-file <file name>.
Read more about signatures in this project.