Skip to main content

Publish your poetry-based projects, without missing important steps

Project description

recite logo

recite

Actions Status Documentation Status Stable python versions Code style: black

recite intends to make releasing poetry-based libraries easier and avoid missing important steps (e.g. adapting the changelog (because you should keep one)).

$ recite release patch

recite > 👀 Checking everything to make sure you are ready to release 👀
recite > 1: ✓ Make sure you have a (non-empty) pyproject.toml
recite > 2: ✓ Make sure you're on main/master branch
recite > 3: ✓ Make sure git is clean
recite > 4: ✓ Run test-suite
recite > 5: ✓ Make sure changelog was updated
recite > 🤓 Everything looks perfect! 🤓
recite > I will perform the following steps:
recite >        * Would bump version from 0.1.0 to 0.1.1
recite >        * Commit version bump
recite >        * Create git tag 0.1.1
recite >        * Push git tag 0.1.1
recite >        * Remind you to upload build as github release
Do you want to proceed? [y/N]: y
recite > ✨ Performing release ✨
recite > 1: ✓ Bump version
recite >        * Bumped version from 0.1.0 to 0.1.1
recite > 2: ✓ Commit version bump
recite > 3: ✓ Create git tag 0.1.1
recite > 4: ✓ Push git tag 0.1.1
recite > 5: ✓ Build and publish with poetry
Please create a github release now! Did you do it? [y/N]: y
recite > 6: ✓ Remind you to upload build as github release
recite > 🚀 Congrats to your release! 🚀

Installation

Since recite is a python application it is recommended to install it via pipx:

$ pipx install recite

But you can also install it via pip:

$ pip install recite

Usage

You can perform e.g a patch release with the command:

$ recite release patch

The classifiers are the same as poetry's bump rules of the it's version command.

To list the available checks use:

$ recite list-checks

You can find more info in the docs

Why?

Previously I used a github action to automatically build and publish a new version of a library if a new tag was pushed. However, sometimes I forgot something crucial (e.g. to adapt the changelog). In this case I had to rush to stop the github action before it would publish the release to pypi (where it would lie forever unable to be rectified). With recite it is ensured all the necessary checks are in place before any tags are created.

Project details


Download files

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

Source Distribution

recite-0.2.2.tar.gz (10.3 kB view details)

Uploaded Source

Built Distribution

recite-0.2.2-py3-none-any.whl (9.7 kB view details)

Uploaded Python 3

File details

Details for the file recite-0.2.2.tar.gz.

File metadata

  • Download URL: recite-0.2.2.tar.gz
  • Upload date:
  • Size: 10.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.1 CPython/3.10.6 Linux/5.19.0-35-generic

File hashes

Hashes for recite-0.2.2.tar.gz
Algorithm Hash digest
SHA256 da974460d71ec680dbf7e725554ea9e044effee23b6cb5522f3a4d4ba31632b9
MD5 5cca6cfc8afc27b4f80a826ca307daaf
BLAKE2b-256 7540e82cb990ac2ba4a23d76272ab333f3c9a18c1acaccb7a60955c90689ffc2

See more details on using hashes here.

File details

Details for the file recite-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: recite-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 9.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.1 CPython/3.10.6 Linux/5.19.0-35-generic

File hashes

Hashes for recite-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 3a86dd05cba93324c1bf3a3a0b1a50047dda32097476642994b55d174389c5cc
MD5 257f2d947f7b2d93f2a14a6834ce5fd5
BLAKE2b-256 06dbc72f9ef3d0b48e80b89e8cf643d981129b4c4d746d693d56829ff78f5f90

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