Skip to main content

make a beautiful click app with rich

Project description

Forks Stargazers Issues MIT License CircleCI



make a beautiful click app with rich

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. Acknowledgments

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


with pip:

pip install click-rich-help

with conda/mamba:

conda install -c conda-forge click-rich-help

(back to top)


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
def cli():
import click
from click_rich_help import StyledCommand

def cmd():

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 | bash

You can also run it yourself if you have installed click-rich-help. Which you should!

python -m click_rich_help.example -h

(back to top)


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

  1. Fork the Project
  2. Install the package and dev dependencies w/poetry(cd click-rich-help; poetry install)
  3. Create your Feature Branch (git checkout -b feat/AmazingFeature)
  4. Commit your Changes (git commit -m 'Add some AmazingFeature')
  5. Run the tests (mypy click_rich_help; py.test tests)
  6. Push to the Branch (git push origin feat/AmazingFeature)
  7. Open a Pull Request

(back to top)


(back to top)

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

click-rich-help-22.1.1.tar.gz (13.3 kB view hashes)

Uploaded Source

Built Distribution

click_rich_help-22.1.1-py3-none-any.whl (13.1 kB view hashes)

Uploaded Python 3

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