Table of Contents
About The Project
I wanted a simple python package to make my click app's help more readable.
Since writing this package the more opinionated rich-click has been written. If that output is more your speed, go check it out! This project aims to provide a slightly different API and set of features.
Getting Started
Installation
with pip:
pip install click-rich-help
with conda/mamba:
conda install -c conda-forge click-rich-help
Usage
As of v22.1.0 you may no longer generate styles using named args.
At a minimum you should apply StyledGroup to your click group.
If you have only one Command or Multicommand you may also use the included StyledCommand or StyledMultiCommand.
import click
from click_rich_help import StyledGroup
@click.group(
cls=StyledGroup,
)
def cli():
pass
import click
from click_rich_help import StyledCommand
@click.command(
cls=StyledCommand,
)
def cmd():
pass
See the documentation for more info
To non-interactively preview the included example module in your own terminal you can run
W/ click-rich-help and curl
curl -s https://raw.githubusercontent.com/daylinmorgan/click-rich-help/main/scripts/example.sh | bash
You can also run it yourself if you have installed click-rich-help. Which you should!
python -m click_rich_help.example -h
Contributing
To contribute please utilize poetry and pre-commit.
optionally manage python installation with conda:
conda create -p ./env python poetry
Then follow the below steps
- Fork the Project
- Install the package and dev dependencies w/poetry(
cd click-rich-help; poetry install) - Create your Feature Branch (
git checkout -b feat/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Run the tests (
mypy click_rich_help; py.test tests) - Push to the Branch (
git push origin feat/AmazingFeature) - Open a Pull Request
Acknowledgments
Metadata
Release files for click-rich-help 22.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| click-rich-help-22.1.1.tar.gz | 13.3 kB | Without provenance | Details for click-rich-help-22.1.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| click_rich_help-22.1.1-py3-none-any.whl | Python 3 | none | any | Details for click_rich_help-22.1.1-py3-none-any.whl |
Total release size: 26.5 kB
Release files / click-rich-help-22.1.1.tar.gz
| Download URL | click-rich-help-22.1.1.tar.gz |
|---|---|
| Size | 13.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ca2b9463ec9950e4726f3aa4b037cde5d2c2d25838ae5a79d08f845760cb4792
|
|
BLAKE2b-256 checksum How to use checksums |
181b1d5480b68b5466eb6c1958bbf9e503126726fbde475f06f4e5dd92ed9fc1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.1.13 CPython/3.8.13 Linux/5.13.0-1017-aws
|
Release files / click_rich_help-22.1.1-py3-none-any.whl
| Download URL | click_rich_help-22.1.1-py3-none-any.whl |
|---|---|
| Size | 13.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ab7c98499283dda2b4ab86f581485856768c0770db030d553f6277bb2ca42303
|
|
BLAKE2b-256 checksum How to use checksums |
78011ea25ce501492486f32a1d3aef194b69fd41ca8bf3a49e060775bb6dec5b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.1.13 CPython/3.8.13 Linux/5.13.0-1017-aws
|
Security for click-rich-help 22.1.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.