Skip to main content

Manage release notes for Python projects

Project description

PyPI - Status PyPI - Wheel PyPI - Python Version GitHub release (latest by date) License GitHub issues PyPI - Downloads GitHub Searches CodeCov GitHub Actions - Pre-Commit GitHub Actions - CI PyPi

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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ReleaseLogIt-0.17.0.tar.gz (6.5 kB view details)

Uploaded Source

Built Distribution

ReleaseLogIt-0.17.0-py3-none-any.whl (6.3 kB view details)

Uploaded Python 3

File details

Details for the file ReleaseLogIt-0.17.0.tar.gz.

File metadata

  • Download URL: ReleaseLogIt-0.17.0.tar.gz
  • Upload date:
  • Size: 6.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for ReleaseLogIt-0.17.0.tar.gz
Algorithm Hash digest
SHA256 1d9507f201aa0adfbc09fa52af6e74a1360d9c6901d9d67ba48703edcd2ff5c5
MD5 70c2effa721db1fee8873b5b965a1c8a
BLAKE2b-256 a20df2339852822755d7b31792e4813abd3303bfedcd1b7d6a85c589dcf4d779

See more details on using hashes here.

File details

Details for the file ReleaseLogIt-0.17.0-py3-none-any.whl.

File metadata

  • Download URL: ReleaseLogIt-0.17.0-py3-none-any.whl
  • Upload date:
  • Size: 6.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for ReleaseLogIt-0.17.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a71d639f393ca5a823b30ff2a73c131a41fdd742f8884f65ee31da55a189da69
MD5 547a34a4dce7ffc22f7c7deed3089c0d
BLAKE2b-256 a59e5233204ef8f770f2f8a142c3284db1bee509a59c8d25c8573980f3e09105

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page