Manage release notes for Python projects
Project description
Manage 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 ReleaseLogIt-0.17.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a71d639f393ca5a823b30ff2a73c131a41fdd742f8884f65ee31da55a189da69 |
|
MD5 | 547a34a4dce7ffc22f7c7deed3089c0d |
|
BLAKE2b-256 | a59e5233204ef8f770f2f8a142c3284db1bee509a59c8d25c8573980f3e09105 |