Insert project description here
Project description
ReleaseIt manages release notes for Python projects.
ReleaseIt keeps release notes for Python projects in a dict structure. It aims to standardise, facilitate and automate the management of release notes when publishing a project to GitHub, PyPI and ReadTheDocs. It is developed as part of the PackageIt project, but can be used independently as well. See also https://pypi.org/project/PackageIt/
Testing
This project uses pytest to run tests and also to test docstring examples.
Install the test dependencies.
$ pip install - r requirements_test.txt
Run the tests.
$ pytest tests
=== XXX passed in SSS seconds ===
Developing
This project uses black to format code and flake8 for linting. We also support pre-commit to ensure these have been run. To configure your local environment please install these development dependencies and set up the commit hooks.
$ pip install black flake8 pre-commit
$ pre-commit install
Releasing
Releases are published automatically when a tag is pushed to GitHub.
# Set next version number
export RELEASE = x.x.x
# Create tags
git commit --allow -empty -m "Release $RELEASE"
git tag -a $RELEASE -m "Version $RELEASE"
# Push
git push upstream --tags
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for ReleaseIt-0.0.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fbf03cae780cbeff05aa8e966839b2b31e72fdf8ffe3d491222a3409f014aaa4 |
|
MD5 | 6d61c7f96973355a571e0a9326f27dbf |
|
BLAKE2b-256 | f012c03d1be43edf71e626af8409b1e9e55ca74106cda61a650d95081daf0ff0 |