| Name | pirel JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | None |
| Summary | The Python release cycle in your terminal |
| upload_time | 2024-12-15 14:49:49 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | The MIT License (MIT) Copyright (c) 2024 RafaelWO Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
cli
python
releases
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Pirel
<div align="center" markdown="1">
**The Python release cycle in your terminal!**
[](https://pypi.org/project/pirel/)
[](https://pypi.org/project/pirel/)
[](https://github.com/RafaelWO/unparallel/blob/main/LICENSE)
</div>
![cli-example][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] FOO
> 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`.
## Development
### Generate Video Demo
To generate the video demo on the top, I used [vhs](https://github.com/charmbracelet/vhs).
If you change something in the "tape" file `./assets/cli_demo.tape` do the following to
update the GIF.
1. `cd assets`
2. `vhs cli_demo.tape`
## Contributing
PRs are welcome! 🤗
This project uses [uv](https://github.com/astral-sh/uv) to manage packaging.
Please check the [corresponding docs](https://docs.astral.sh/uv/) for installation instructions.
Before you commit any changes, please ensure that you have [pre-commit](https://pre-commit.com)
available on your system. Run `pre-commit install` to install the project's hooks.
<!-- Links -->
[cli-example]: https://raw.githubusercontent.com/RafaelWO/pirel/refs/heads/main/assets/images/cli_demo.gif
Raw data
{
"_id": null,
"home_page": null,
"name": "pirel",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "cli, python, releases",
"author": null,
"author_email": "Rafael Weingartner-Ortner <weingartner.rafael@hotmail.com>",
"download_url": "https://files.pythonhosted.org/packages/96/b5/b34e5efdd879d1789ac4a6b4129b3cfd90c5490282d408a4d392066d9718/pirel-0.2.0.tar.gz",
"platform": null,
"description": "# Pirel\n\n<div align=\"center\" markdown=\"1\">\n\n**The Python release cycle in your terminal!**\n\n[](https://pypi.org/project/pirel/)\n[](https://pypi.org/project/pirel/)\n[](https://github.com/RafaelWO/unparallel/blob/main/LICENSE)\n\n</div>\n\n\n![cli-example][cli-example]\n\n\n## Installation\nIt is recommended to install Pirel as a globally available CLI tool via `pipx` (or `uv tool`, etc.).\nThis way you Pirel will show you the status of your active Python interpreter.\n\n```\npipx install pirel\n```\n\nYou can also install Pirel into a specific virtual environment.\n\n```\npip install pirel\n```\n\n\n## Usage\n\n### Check Active Python Version\n```\nUsage: pirel check [OPTIONS]\n\nShows release information about your active Python interpreter.\nIf no active Python interpreter is found, the program exits with code 2.\n\n\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 --verbose -v INTEGER Enable verbose logging; can be supplied multiple times to increase \u2502\n\u2502 verbosity. \u2502\n\u2502 [default: 0] \u2502\n\u2502 --help Show this message and exit. \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n```\n\n\n### List Python Releases\n```\nUsage: pirel list [OPTIONS]\n\nLists all Python releases in a table. Your active Python interpreter is highlighted.\n\n\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 --verbose -v INTEGER Enable verbose logging; can be supplied multiple times to increase \u2502\n\u2502 verbosity. \u2502\n\u2502 [default: 0] \u2502\n\u2502 --help Show this message and exit. \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n\n```\n\n> [!NOTE] FOO\n> You can still invoke `pirel` without a subcommand and you will get a table of all Python releases.\n> But note that this is **deprecated**, i.e. please use `pirel list`.\n\n\n## Development\n### Generate Video Demo\nTo generate the video demo on the top, I used [vhs](https://github.com/charmbracelet/vhs).\n\nIf you change something in the \"tape\" file `./assets/cli_demo.tape` do the following to\nupdate the GIF.\n\n1. `cd assets`\n2. `vhs cli_demo.tape`\n\n\n## Contributing\nPRs are welcome! \ud83e\udd17\n\nThis project uses [uv](https://github.com/astral-sh/uv) to manage packaging.\nPlease check the [corresponding docs](https://docs.astral.sh/uv/) for installation instructions.\n\nBefore you commit any changes, please ensure that you have [pre-commit](https://pre-commit.com)\navailable on your system. Run `pre-commit install` to install the project's hooks.\n\n\n<!-- Links -->\n[cli-example]: https://raw.githubusercontent.com/RafaelWO/pirel/refs/heads/main/assets/images/cli_demo.gif\n",
"bugtrack_url": null,
"license": "The MIT License (MIT) Copyright (c) 2024 RafaelWO Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "The Python release cycle in your terminal",
"version": "0.2.0",
"project_urls": {
"Changelog": "https://github.com/RafaelWO/pirel/blob/main/CHANGELOG.md",
"Homepage": "https://github.com/RafaelWO/pirel",
"Issues": "https://github.com/RafaelWO/pirel/issues",
"Repository": "https://github.com/RafaelWO/pirel"
},
"split_keywords": [
"cli",
" python",
" releases"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ccb86c379029d07489175b945ab52d5662a369f0d68ad63d07e88f05deb3a022",
"md5": "f4847eddf8167f35e2ca05e68cb041aa",
"sha256": "7791ea206f28ccb260020f1b49ac18607f27e0ddc250b85fc968cc86fc1a3dde"
},
"downloads": -1,
"filename": "pirel-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f4847eddf8167f35e2ca05e68cb041aa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 8919,
"upload_time": "2024-12-15T14:49:46",
"upload_time_iso_8601": "2024-12-15T14:49:46.846000Z",
"url": "https://files.pythonhosted.org/packages/cc/b8/6c379029d07489175b945ab52d5662a369f0d68ad63d07e88f05deb3a022/pirel-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "96b5b34e5efdd879d1789ac4a6b4129b3cfd90c5490282d408a4d392066d9718",
"md5": "54ee0286e9b1aad3ecd5551ab0404099",
"sha256": "f6ee3140dacfb67e4c14928cc305b922d993b5a3c4771d89e1ef32c62b8551aa"
},
"downloads": -1,
"filename": "pirel-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "54ee0286e9b1aad3ecd5551ab0404099",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 414644,
"upload_time": "2024-12-15T14:49:49",
"upload_time_iso_8601": "2024-12-15T14:49:49.336520Z",
"url": "https://files.pythonhosted.org/packages/96/b5/b34e5efdd879d1789ac4a6b4129b3cfd90c5490282d408a4d392066d9718/pirel-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-15 14:49:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "RafaelWO",
"github_project": "pirel",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pirel"
}
