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
File details
Details for the file ReleaseIt-0.9.0.tar.gz
.
File metadata
- Download URL: ReleaseIt-0.9.0.tar.gz
- Upload date:
- Size: 6.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.8
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ac26c0ae57149a42aaabc1f63c45b71f241311c3f8e341fc363c7882de4f61f9 |
|
MD5 | db7ca20fafdd102c3a3292a6134f732f |
|
BLAKE2b-256 | 96b499f86cfd78fba9627243d32da81a658695d93a0835cf0b1bb76e3bb76d31 |
File details
Details for the file ReleaseIt-0.9.0-py3-none-any.whl
.
File metadata
- Download URL: ReleaseIt-0.9.0-py3-none-any.whl
- Upload date:
- Size: 6.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.8
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | e053f764332f299626f926a40d6879415b0c6b6fa9cc76ca9203e3e441f3ff9d |
|
MD5 | 99d06278e1fde15de82915ad3c115f8b |
|
BLAKE2b-256 | 7be8fbfc2054e3baa1758bd2f5e36e0b01faf82e7b786b20b3e8e7b654023087 |