Skip to content

RafaelWO/pirel

Repository files navigation

Pirel

The Python release cycle in your terminal!

Package Version Python Version License

cli-example

Installation

It is recommended to install Pirel as a globally available CLI tool via pipx (or uv tool, etc.). This way you Pirel will show you the status of your active Python interpreter.

pipx install pirel

You can also install Pirel into a specific virtual environment.

pip install pirel

Usage

Check Active Python Version

Usage: pirel check [OPTIONS]

Shows release information about your active Python interpreter.
If no active Python interpreter is found, the program exits with code 2.

╭─ Options ───────────────────────────────────────────────────────────────────────────────╮
│ --verbose  -v      INTEGER  Enable verbose logging; can be supplied multiple times to   │
│                             increase verbosity.                                         │
│                             [default: 0]                                                │
│ --help                      Show this message and exit.                                 │
╰─────────────────────────────────────────────────────────────────────────────────────────╯

List Python Releases

Usage: pirel list [OPTIONS]

Lists all Python releases in a table. Your active Python interpreter is highlighted.

╭─ Options ───────────────────────────────────────────────────────────────────────────────╮
│ --verbose  -v      INTEGER  Enable verbose logging; can be supplied multiple times to   │
│                             increase verbosity.                                         │
│                             [default: 0]                                                │
│ --help                      Show this message and exit.                                 │
╰─────────────────────────────────────────────────────────────────────────────────────────╯

Note

You can still invoke pirel without a subcommand and you will get a table of all Python releases. But note that this is deprecated, i.e. please use pirel list.

Contributing

PRs are welcome! 🤗

This project uses uv to manage packaging. Please check the corresponding docs for installation instructions.

Before you commit any changes, please ensure that you have pre-commit available on your system. Run pre-commit install to install the project's hooks.

Development

Generate Video Demo

To generate the video demo on the top, I used vhs.

If you change something in the "tape" file ./assets/cli_demo.tape run the following command to update the GIF: vhs assets/cli_demo.tape