Richly rendered command line interfaces in click.
Documentation · Source Code · Changelog
--- **rich-click** is a wrapper around [Click](https://click.palletsprojects.com/) that renders help output nicely using [Rich](https://github.com/Textualize/rich). - Click is a _"Python package for creating beautiful command line interfaces"_. - Rich is a _"Python library for rich text and beautiful formatting in the terminal"_. The intention of `rich-click` is to provide attractive help output from Click, formatted with Rich, with minimal customization required. ## Features - 🌈 Rich command-line formatting of click help and error messages - 😌 Same API as Click: usage is simply `import rich_click as click` - 🎨 Over 100 themes that can be set by developers and end-users (`export RICH_CLICK_THEME=...`) - 💻 CLI tool to run on _other people's_ Click and Typer CLIs (prefix the command with `rich-click`) - 📦 Export help text as HTML or SVG - 🎁 Group commands and options into named panels - ❌ Well formatted error messages - 💫 Extensive customization - 🤖 IDE autocomplete of Click decorators for smooth developer experience ## Installation ```shell pip install rich-click ``` ## Examples ### Simple Example To use rich-click in your code, replace `import click` with `import rich_click as click` in your existing click CLI: ```python import rich_click as click @click.command() @click.option("--count", default=1, help="Number of greetings.") @click.option("--name", prompt="Your name", help="The person to greet.") def hello(count, name): """Simple program that greets NAME for a total of COUNT times.""" for _ in range(count): click.echo(f"Hello, {name}!") if __name__ == '__main__': hello() ```  _Screenshot from [`examples/11_hello.py`](https://github.com/ewels/rich-click/blob/main/examples/11_hello.py)_ ### More complex example **rich-click** has a ton of customization options that let you compose help text however you'd like. Below is a more complex example of what **rich-click** is capable of, utilizing **themes** and **panels**:  _Screenshot from [`examples/03_groups_sorting.py`](https://github.com/ewels/rich-click/blob/main/examples/03_groups_sorting.py)_ ## Usage This is a quick overview of how to use **rich-click**. [Read the docs](https://ewels.github.io/rich-click) for more information. There are a couple of ways to begin using `rich-click`: ### Import `rich_click` as `click` Switch out your normal `click` import with `rich_click`, using the same namespace: ```python import rich_click as click ``` That's it! ✨ Then continue to use Click as you would normally. > See [`examples/01_simple.py`](https://github.com/ewels/rich-click/blob/main/examples/01_simple.py) for an example. ### Declarative If you prefer, you can use `RichGroup` or `RichCommand` with the `cls` argument in your click usage instead. This means that you can continue to use the unmodified `click` package in parallel. ```python import click from rich_click import RichCommand @click.command(cls=RichCommand) def main(): """My amazing tool does all the things.""" ``` > See [`examples/02_declarative.py`](https://github.com/ewels/rich-click/blob/main/examples/02_declarative.py) for an example. ### `rich-click` CLI tool **rich-click** comes with a CLI tool that allows you to format the Click help output from _any_ package that uses Click. To use, prefix `rich-click` to your normal command. For example, to get richified Click help text from a package called `awesometool`, you could run: ```console $ rich-click awesometool --help Usage: awesometool [OPTIONS] ..more richified output below.. ``` ## License This project is licensed under the MIT license. rich-click-1.9.9/docs/ 0000775 0000000 0000000 00000000000 15247065310 0014475 5 ustar 00root root 0000000 0000000 rich-click-1.9.9/docs/_deploy.py 0000664 0000000 0000000 00000002465 15247065310 0016511 0 ustar 00root root 0000000 0000000 # fmt: off # /// script # requires-python = ">=3.13" # dependencies = [ # "packaging" # ] # /// import os from importlib.metadata import version import subprocess import json import packaging.version def get_latest(): res = subprocess.run(["mike", "list", "latest", "-j"], stdout=subprocess.PIPE, stderr=subprocess.PIPE, check=True,) if not res.stdout: # First deploy return None data = json.loads(res.stdout) major, minor, *_ = data["version"].split(".") return int(major), int(minor) def deploy(): subprocess.run( ["git", "fetch", "origin", "gh-pages:gh-pages"], stdout=subprocess.PIPE, stderr=subprocess.PIPE, check=True ) v = packaging.version.parse(version(os.environ["PACKAGE_NAME"])) latest = get_latest() cmd = ["mike", "deploy", "--push", "--update-aliases", f"{v.major}.{v.minor}"] if v.is_prerelease: cmd.append("prerelease") elif latest is None or (v.major, v.minor) > latest: cmd.append("latest") print(f"Running {' '.join(cmd)}") subprocess.run( cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, check=True ) subprocess.run([ "mike", "set-default", "--push", "latest"], stdout=subprocess.PIPE, stderr=subprocess.PIPE, check=False ) if __name__ == "__main__": deploy() rich-click-1.9.9/docs/assets/ 0000775 0000000 0000000 00000000000 15247065310 0015777 5 ustar 00root root 0000000 0000000 rich-click-1.9.9/docs/assets/fonts/ 0000775 0000000 0000000 00000000000 15247065310 0017130 5 ustar 00root root 0000000 0000000 rich-click-1.9.9/docs/assets/fonts/pixelmix.ttf 0000664 0000000 0000000 00000053250 15247065310 0021513 0 ustar 00root root 0000000 0000000 PFFTM\b V GDEF $ Vd (OS/2fw X `cmapo @ gasp V\ glyf 8 8@head7 6hhea $hmtx locaș0 Hmaxp & 8 nameCX Fx post,K L P Z$M_< O O $ 3 @ FSTR @ ~ xO & : !" x & 9 !" JC|{vd~ ! " # $ % & ' ( ) * + , - . / 0 1 2 3 4 5 6 7 8 9 : ; < = > ? @ A B C D E F G H I J K L M N O P Q R S T U V W X Y Z [ \ ] ^ _ ` a r d e i x p k v j s g w l | c n m } b y q z 2 ` 8Zn8h0\n Jh 8Lj4f 0l$6Vz @ Z x 2 R r P p , 8 D X d p " @ L X d p | (4@LXdp| P\ht (4@LXdp|&2>JVbnz ".:FR^jv *6BNZfr~&2>JVbnz ".:FR^jv *6BNZfr~&2>JVbnz ".:FR^jv *6BNZfr~&2>JVbnz $2>J^r~ 1! 1533 333 #5#53#53533533#3##5# # =3!33%5353#53#5!#3#3 153!!%35353%!%53 # 35!353%53!375!353%53%!## 3 !53%53%353=3 153=35353%53 5#53533# %!5!3!! 35#5! 5! 1! 1333 35!5333#!#53535! 153#53533 15353!53=35335! 35!%53!353%53=!5!# 53!3!#53533# 35!%53!3!!! 35!53!3!!53=! 3353=3=!5! 35!%3!35!%3!35! 35!=335!5!35! =353 35#5!53 !53%53%53%53=3=3=3 5!5! 153=3=3=3%53%53%53 35353=35335! 35!5#37!335! 13!3#!5! %33!!!!! 35!=3!353%5! %3!!! 1!!!!! 1!!!! 35!!5!%353%5! 13!3#! 153#5!#3 35!%53!#5!# !53%53%5353=333#53 13! 333#!#5353 5333#!#533 35!%3!35! 3!!!! 35!353%53%533%35! !53%533!!!##5# 15!535!%35! !!5!! 35!%3!3 !53%3333!3 353353%3!3!3 # 13!353353%53%53353%3!3 !353353%3!3 13!53=3=3=!5! 1!#3 !333 153#5! 53!53%53353%53 15! 53%53 =3 5!5!5!535! %35!33#! 35!=3!35! 535!5!#533 35!%3!53!5! 3#5333#53%5! 35!35!5!!5! !35!33# 153#5!353 35!%53!353 !53%5353=333# 153#5!3 33!!#53 !3!33#5! 35!%3!35! 53!!!! 53=!!5!5353 5333#5! 15!=3%5!%53=! !5!=3!#5333# 35!%3!3 !53%53353%3!3 353353%3!3!3 # 153!53%53353%53%53353%53!53 35!35!5!3 15353!53=!5!# 333535!# 13 153353%#5! 53%53353353%53 15! 1! 1! 1! 1! 1! 133 1! 1! 35!!#33!35! 1! 353!53%53!53%53!53 1! 5! 1! 5! 5!%3!35! 15!!5!3!! 1! 1! 1! 1! 1! 53 1! 1! 1! 153!53%53!53%53!53 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! # 153!53%53353%53%53353%53!53 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! !535!53 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 5! 3 3 1! 1! 333 333 1! !!5!3!! 153353353 !53%53%53=3=3 153=3=3%53%53 1! 1! 1! 1! V 0 b + l @ % 4 ) ` V J } 4 4[ J h R C o p y r i g h t A n d r e w T y l e r 2 0 1 2 f o n t @ a n d r e w t y l e r . n e t Copyright Andrew Tyler 2012 font@andrewtyler.net p i x e l m i x pixelmix R e g u l a r Regular F o n t F o r g e 2 . 0 : p i x e l m i x R e g u l a r : 1 - 2 - 2 0 1 2 FontForge 2.0 : pixelmix Regular : 1-2-2012 p i x e l m i x R e g u l a r pixelmix Regular V e r s i o n 1 . 0 Version 1.0 p i x e l m i x pixelmix A n d r e w T y l e r Andrew Tyler A n d r e w T y l e r Andrew Tyler h t t p : / / w w w . a n d r e w t y l e r . n e t http://www.andrewtyler.net h t t p : / / w w w . a n d r e w t y l e r . n e t http://www.andrewtyler.net C r e a t i v e C o m m o n s A t t r i b u t i o n B Y N C N D Creative Commons Attribution BY NC ND h t t p : / / c r e a t i v e c o m m o n s . o r g / l i c e n s e s / b y - n c - n d / 3 . 0 / u s / http://creativecommons.org/licenses/by-nc-nd/3.0/us/ F i v e b i g q u a c k i n g z e p h y r s j o l t m y w a x b e d Five big quacking zephyrs jolt my wax bed e 3 ! " # $ % & ' ( ) * + , - . / 0 1 2 3 4 5 6 7 8 9 : ; < = > ? @ A B C D E F G H I J K L M N O P Q R S T U V W X Y Z [ \ ] ^ _ ` a b c d e f g h j i k m l n o q p r s u t v w x z y { } | ~ !"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~ glyph1uni000Duni00A0uni00ADuni00B2uni00B3uni00B5uni00B9uni0180uni0181uni0182uni0183uni0184uni0185uni0186uni0187uni0188uni0189uni018Auni018Buni018Cuni018Duni018Euni018Funi0190uni0191uni0193uni0194uni0195uni0196uni0197uni0198uni0199uni019Auni019Buni019Cuni019Duni019Euni019FOhornohornuni01A2uni01A3uni01A4uni01A5uni01A6uni01A7uni01A8uni01A9uni01AAuni01ABuni01ACuni01ADuni01AEUhornuhornuni01B1uni01B2uni01B3uni01B4uni01B5uni01B6uni01B7uni01B8uni01B9uni01BAuni01BBuni01BCuni01BDuni01BEuni01BFuni01C0uni01C1uni01C2uni01C3uni01C4uni01C5uni01C6uni01C7uni01C8uni01C9uni01CAuni01CBuni01CCuni01CDuni01CEuni01CFuni01D0uni01D1uni01D2uni01D3uni01D4uni01D5uni01D6uni01D7uni01D8uni01D9uni01DAuni01DBuni01DCuni01DDuni01DEuni01DFuni01E0uni01E1uni01E2uni01E3uni01E4uni01E5Gcarongcaronuni01E8uni01E9uni01EAuni01EBuni01ECuni01EDuni01EEuni01EFuni01F0uni01F1uni01F2uni01F3uni01F4uni01F5uni01F6uni01F7uni01F8uni01F9 Aringacute aringacuteAEacuteaeacute Oslashacute oslashacuteuni0200uni0201uni0202uni0203uni0204uni0205uni0206uni0207uni0208uni0209uni020Auni020Buni020Cuni020Duni020Euni020Funi0210uni0211uni0212uni0213uni0214uni0215uni0216uni0217 Scommaaccent scommaaccentuni021Auni021Buni021Cuni021Duni021Euni021Funi0220uni0221uni0222uni0223uni0224uni0225uni0226uni0227uni0228uni0229uni022Auni022Buni022Cuni022Duni022Euni022Funi0230uni0231uni0232uni0233uni0234uni0235uni0236uni0237uni0238uni0239uni023Auni023Buni023Cuni023Duni023Euni023Funi0240uni0241uni0242uni0243uni0244uni0245uni0246uni0247uni0248uni0249uni024Auni024Buni024Cuni024Duni024Euni024F quotereversedEurouniFB01uniFB02 ɉo1 t O c rich-click-1.9.9/docs/blog/ 0000775 0000000 0000000 00000000000 15247065310 0015420 5 ustar 00root root 0000000 0000000 rich-click-1.9.9/docs/blog/.authors.yml 0000664 0000000 0000000 00000000343 15247065310 0017706 0 ustar 00root root 0000000 0000000 authors: ewels: name: Phil Ewels description: rich-click creator avatar: https://github.com/ewels.png dwreeves: name: Daniel Reeves description: Co-maintainer avatar: https://github.com/dwreeves.png rich-click-1.9.9/docs/blog/index.md 0000664 0000000 0000000 00000000054 15247065310 0017050 0 ustar 00root root 0000000 0000000 --- hide: - toc - navigation --- # Blog rich-click-1.9.9/docs/blog/posts/ 0000775 0000000 0000000 00000000000 15247065310 0016570 5 ustar 00root root 0000000 0000000 rich-click-1.9.9/docs/blog/posts/pycon-sweden-2024.md 0000664 0000000 0000000 00000002507 15247065310 0022116 0 ustar 00root root 0000000 0000000 --- draft: false slug: pycon-sweden-2024 date: 2024-11-15 authors: - ewels categories: - Miscellaneous --- # PyCon Sweden 2024 I had the great pleasure of presenting **rich-click** at [PyCon Sweden 2024](https://www.pycon.se/) today. It was my first time attending and a lot of fun! You can find my slides below: ## YouTube video [Watch on YouTube :octicons-link-external-16:](https://youtu.be/vGSYj_5tGmY){ .md-button } ## Slides [Open in new tab :octicons-link-external-16:](../../images/blog/pycon-sweden-2024/Ewels-PyCon-Sweden-2024.pdf){ .md-button } ## Thanks! Many thanks to the conference organisers for the opportunity! And as mentioned in the talk - many thanks to the contributors who made this project possible. rich-click-1.9.9/docs/blog/posts/three-pre-made-styles.md 0000664 0000000 0000000 00000017705 15247065310 0023244 0 ustar 00root root 0000000 0000000 --- draft: false slug: three-pre-made-styles date: 2024-11-13 authors: - dwreeves categories: - Miscellaneous --- # Three cool pre-made styles for your CLI **rich-click**'s default style is nice, and naturally it's what most of our users end up using. But we won't be offended if you want to change things up! **rich-click** is flexible in terms of the custimisation options it gives you. In this blog post, we want to highlight a few neat design ideas for your CLI that you can do with **rich-click**. ## 1. Simple boxless one-color CLI You may associate **rich-click** with boxes, but did you know you can strip the box away? Here is an example of a **rich-click** style that does just that, and produces a nice and clean one-color format: ??? success "Code for `1. Simple boxless one-color CLI`" ```python # /// script # dependencies = [ # "rich-click", # ] # /// import rich_click as click help_config = click.RichHelpConfiguration( style_options_panel_box="SIMPLE_HEAD", style_commands_panel_box="SIMPLE_HEAD", style_options_panel_border="bold", options_panel_title="[u]Options[/]", style_commands_panel_border="bold", commands_panel_title="[u]Commands[/]", style_option="blue", style_usage="", style_usage_command="", style_argument="blue", style_switch="bold blue", style_command="blue", style_metavar="dim", text_markup="markdown", max_width=100 ) @click.group("app") @click.option("--env-file", "-e", type=click.Path(), help=".env file") @click.rich_config(help_config=help_config) def cli(): """ CLI for `app` This `app` lets you do cool things. """ @cli.command("db") def deploy(): """Database commands for app""" @cli.command("deploy") def deploy(): """Deploy app""" @cli.command("self") def self(): """Manage app""" if __name__ == "__main__": cli() ``` {.screenshot} ## 2. Dark mode / light mode aware with three colors For now, neither Rich nor **rich-click** has a concept of dark mode or light mode. However, there are third party packages that can detect the background color of most terminals. Checking the terminal bg makes using RGB hex values much easier. Here is an example of such a tool you can use: === "pip" ```shell pip install term-background ``` === "uv" ```shell uv add term-background ``` === "Rye" ```shell rye add term-background rye sync ``` The following example looks great in both dark and light terminals! ??? success "Code for `2. Dark mode / light mode aware with three colors`" ```python # /// script # dependencies = [ # "rich-click", # "term-background", # ] # /// import rich_click as click from term_background import is_dark_background if is_dark_background(): primary_color = "#99bbf2" secondary_color = "#c099f2" tertiary_color = "#d1d43d" else: primary_color = "#2b569c" secondary_color = "#5c2b9c" tertiary_color = "#c4b74f" help_config = click.RichHelpConfiguration( style_option=f"bold {secondary_color}", style_argument=f"bold {tertiary_color}", style_command=f"bold {primary_color}", style_switch=f"bold {secondary_color}", style_metavar=tertiary_color, style_metavar_separator="", style_usage=f"bold {primary_color}", style_usage_command="", style_helptext_first_line="bold", style_helptext="", style_option_default=tertiary_color, style_required_short="bold red", style_required_long="red", style_options_panel_border=f"dim {secondary_color}", style_commands_panel_border=f"dim {primary_color}", text_markup="markdown", max_width=120 ) @click.group("app") @click.option("--env-file", "-e", type=click.Path(), help=".env file") @click.rich_config(help_config=help_config) def cli(): """ CLI for `app` This `app` lets you do cool things. """ @cli.command("db") def deploy(): """Database commands for app""" @cli.command("deploy") def deploy(): """Deploy app""" @cli.command("self") def self(): """Manage app""" if __name__ == "__main__": cli() ``` === "Dark mode" {.screenshot} === "Light mode" {.screenshot} ## 3. Gradient art header The following example combines ideas from the first two examples, and then adds in `text2art` from the `art` package with `Gradient` from the `rich-gradient` package. The below example requires `rich-click>=1.8.4`, as previous versions do not support `Gradient()` objects for the `header_text`. === "pip" ```shell pip install term-background art rich-gradient ``` === "uv" ```shell uv add term-background art rich-gradient ``` === "Rye" ```shell rye add term-background rye add art rye add rich-gradient rye sync ``` ??? success "Code for `3. Gradient art header`" ```python # /// script # dependencies = [ # "rich-click>=1.8.4", # "term-background", # "art", # "rich-gradient", # ] # /// import rich_click as click from art import text2art from rich_gradient import Gradient from term_background import is_dark_background if is_dark_background(): primary_color = "#99ff00" secondary_color = "#ffdd00" else: primary_color = "#77bb22" secondary_color = "#aa9922" help_config = click.RichHelpConfiguration( style_options_panel_box="SIMPLE", style_commands_panel_box="SIMPLE", style_option=f"bold {secondary_color}", style_argument=secondary_color, style_command=primary_color, options_panel_title="[u]Options[/]", commands_panel_title="[u]Commands[/]", style_switch=secondary_color, style_metavar="bold", header_text=Gradient(text2art("My App"), colors=[primary_color, secondary_color]), style_metavar_separator="", style_usage=f"bold {primary_color}", style_usage_command="", style_helptext_first_line="bold", style_helptext="", style_option_default="", style_required_short="bold", style_required_long="", style_options_panel_border=f"bold {secondary_color}", style_commands_panel_border=f"bold {primary_color}", text_markup="markdown", max_width=120 ) @click.group("app") @click.option("--env-file", "-e", type=click.Path(), help=".env file") @click.rich_config(help_config=help_config) def cli(): """ CLI for `app` This `app` lets you do cool things. """ @cli.command("db") def deploy(): """Database commands for app""" @cli.command("deploy") def deploy(): """Deploy app""" @cli.command("self") def self(): """Manage app""" if __name__ == "__main__": cli() ``` {.screenshot} ## Parting notes Thank you for reading, and I hope you find this blog helpful and inspiring. Phil and I have been really busy on a bunch of other things, but we haven't forgotten about our roadmap for **rich-click** 1.9. We hope to get `1.9.0` released by the middle of 2025. Stay tuned for more updates! Lastly, if you are attending [PyCon Sweden](https://www.pycon.se/) on November 14-15, 2024, be sure to check out [Phil Ewels' talk about **rich-click**](https://pretalx.com/pyconse-2024/talk/XP7GWN/). rich-click-1.9.9/docs/blog/posts/version-1.8.md 0000664 0000000 0000000 00000061405 15247065310 0021111 0 ustar 00root root 0000000 0000000 --- draft: false slug: version-1.8 date: 2024-04-30 authors: - dwreeves - ewels categories: - Release notes --- # New blog + v1.8 released! Today we are very happy to release version 1.8 of rich-click, and along with it - this blog! ## New docs website and blog Until now, **rich-click** has just had a GitHub repo and all documentation has been in the README. Now, we have full docs! We've fleshed out the documentation from the README, and we'll continue to add to it over time. ### Live Style Editor The coolest addition allowed by this change to full documentation is the [Live Style Editor](https://ewels.github.io/rich-click/latest/editor). We built this to address a problem we noticed, which is that the vast majority of users rely on the default **rich-click** styles. Although we do think **rich-click**'s defaults are pretty good, it pointed to a potential developer experience issue that so many CLIs relied on the defaults. We hope that the live style editor makes it easier for users to make style changes and to personalize their CLIs. 😁 Here is an example of a style that Phil made with the style editor: ??? success "Phil's Generated Code" ```python import rich_click as click help_config = click.RichHelpConfiguration( style_option="bold cyan", style_argument="bold cyan", style_command="bold green", style_switch="bold green", style_metavar="green", style_metavar_separator="dim blue", style_usage="bold italic magenta", style_usage_command="bold yellow", style_helptext_first_line="bold italic white", style_helptext="dim italic yellow", style_option_default="bold yellow", style_required_short="bold red", style_required_long="bold red", style_options_panel_border="italic blue", style_commands_panel_border="italic blue" ) @click.group("my-command") @click.argument("foo") @click.option("--bar", "-b", help="Lorem ipsum", show_default="someval") @click.option("--baz", required=True, help="Choose wisely", type=click.Choice(["a", "b", "c"])) @click.rich_config(help_config=help_config) def cli(foo, bar): """ Help text for CLI Second line of help text. """ @cli.command("subcommand") def subcommand(foo, bar): """Help text for subcommand""" if __name__ == "__main__": cli() ``` {.screenshot} And here's one that Daniel made: ??? success "Daniel's Generated Code" ```python import rich_click as click help_config = click.RichHelpConfiguration( style_option="bold magenta", style_argument="bold yellow", style_command="bold blue", style_switch="bold magenta", style_metavar="yellow", style_metavar_separator="", style_usage="bold blue", style_usage_command="", style_helptext_first_line="bold", style_helptext="", style_option_default="yellow", style_required_short="bold red", style_required_long="red", style_options_panel_border="magenta", style_commands_panel_border="blue" ) @click.group("my-command") @click.argument("foo") @click.option("--bar", "-b", help="Lorem ipsum", show_default="someval") @click.option("--baz", required=True, help="Choose wisely", type=click.Choice(["a", "b", "c"])) @click.rich_config(help_config=help_config) def cli(foo, bar): """ Help text for CLI Second line of help text. """ @cli.command("subcommand") def subcommand(foo, bar): """Help text for subcommand""" if __name__ == "__main__": cli() ``` {.screenshot} ## **rich-click** version 1.8 ### Generate HTML and SVG with the `rich-click` CLI The `rich-click` CLI now allows for `--output svg` and `--output html` to help easily generate outputs for READMEs and docs: ```shell rich-click --output svg path.to.my.cli:main --help ``` {.screenshot} ### Easier decorator API The `rich_config()` decorator API is now easier to use: You can pass a `dict` into the `@click.rich_config()` decorator. E.g.: ```python @click.command @click.rich_config(help_config={"max_width": 100}) def my_command(): ... ``` Additionally, `dict`s behave a little differently than `RichHelpConfiguration` when dealing with parents, and this behavior can be useful in some contexts. Basically, the child command uses the parent's help config as a baseline, and only updates the fields specified in the dict. So in the following example, `my_group` will have `style_option="red"`, and `my_subcommand` will have _both_ `style_option="red"` and `style_argument="green"`. ```python @click.group @click.rich_config(help_config={"style_option": "red"}) def my_group(): ... @my_group.command @click.rich_config(help_config={"style_argument": "green"}) def my_subcommand(): ... ``` This can be a little confusing, so we've defined explicit rules (and enforced them in unit tests) for how the config is resolved (these are also in our docs): ```mermaid flowchart TD A["Did you pass in a @rich_config(help_config=...)?"] A --> |Yes| Ayes A --> |No| Ano Ayes["Was it a dict or a RichHelpConfiguration?"] Ayes --> |dict| AyesBdict Ayes --> |RichHelpConfiguration| AyesBrhc AyesBdict["Is there a 'parent' config?"] AyesBdict --> |Yes| AyesBdictCyes AyesBdict --> |No| AyesBdictCno AyesBdictCyes:::StoppingPoint AyesBdictCyes["Merge into the parent config,\nand use that"] AyesBdictCno:::StoppingPoint AyesBdictCno["Merge into the global config,\nand use that"] AyesBrhc:::StoppingPoint AyesBrhc["Use the RichHelpConfiguration object.\n\n(Note: RichHelpConfiguration's\ndefaults are independent of the\nglobal config.)"] Ano["Is there a 'parent' config?"] Ano --> |Yes| AnoByes Ano --> |No| AnoBno AnoByes:::StoppingPoint AnoByes["Use the parent config"] AnoBno:::StoppingPoint AnoBno["Use the global config"] classDef StoppingPoint font-weight: 600; ``` ### More style options The biggest addition to **rich-click**'s styling options was control over panel styles: - `STYLE_OPTIONS_PANEL_BOX` - `STYLE_COMMANDS_PANEL_BOX` - `STYLE_ERRORS_PANEL_BOX` Here's a silly example of what this can do: ??? note "Code for silly example" ```python import rich_click as click help_config = click.RichHelpConfiguration( style_options_panel_box="ASCII", style_commands_panel_box="HEAVY", ) @click.group("app") @click.option("--env-file", "-e", type=click.Path(), help=".env file") @click.rich_config(help_config=help_config) def cli(): """ CLI for `app` This `app` lets you do cool things. """ @cli.command("db") def deploy(): """Database commands for app""" @cli.command("deploy") def deploy(): """Deploy app""" @cli.command("self") def self(): """Manage app""" if __name__ == "__main__": cli() ``` {.screenshot} Here's a simple, stylish, and sleek example that would look great in your app: ??? note "Code for stylish example" ```python import rich_click as click help_config = click.RichHelpConfiguration( style_options_panel_box="SIMPLE_HEAD", style_options_table_box="SIMPLE_HEAD", style_commands_panel_box="SIMPLE_HEAD", style_commands_table_box="SIMPLE_HEAD", style_options_panel_border="bold", options_panel_title="[u]Options[/]", use_rich_markup=True, style_commands_panel_border="bold", commands_panel_title="[u]Commands[/]", style_option="green", style_usage="", style_usage_command="", style_argument="green", style_switch="dim green", style_command="green", style_metavar="dim", ) @click.group("app") @click.option("--env-file", "-e", type=click.Path(), help=".env file") @click.rich_config(help_config=help_config) def cli(): """ CLI for `app` This `app` lets you do cool things. """ @cli.command("db") def deploy(): """Database commands for app""" @cli.command("deploy") def deploy(): """Deploy app""" @cli.command("self") def self(): """Manage app""" if __name__ == "__main__": cli() ``` {.screenshot} ### Improvements to option and command group API The option groups and command groups are a very powerful and useful feature, but historically they've been tricky to work with. The changes we've made in 1.8 improve on the API in a few substantial ways. #### Better command path resolution First, group keys used to only read from the `ctx.command_path`. Now they read from the `ctx.command_path` and the `ctx.command.name` (or the `f"{ctx.parent.command.name} {ctx.command.name}"` for subcommands). This should cause fewer headaches for users! ??? note "Longer explanation" What this means in practical terms is easier to explain by example. For example, the command path for `python hello.py --name world` is `hello.py`, but if you were to set `hello` as a console script entry point in your `pyproject.toml` or `setup.py`, then the command path for `hello --name world` would become `hello`. This causes an annoying issue where running `python my_script.py` and `venv/bin/my_script` had different behaviors, and it was also unintuitive that the name of the CLI didn't always work, even when it's not an entry point. Now, both approaches work! 😊 ```python # cli.py import rich_click as click # Pick your poison 🧪 Both approaches now work! click.rich_click.COMMAND_GROUPS = { "super-cool-tool": [...], # `ctx.command.name` "cli.py": [...] # `ctx.command_path` when running "python cli.py". } @click.command("super-cool-tool") def main(): ... ``` #### Wildcards Wildcards now also work, in case you want to globally define options or simply don't want to bother spelling out the whole command path. ```python import rich_click as click click.rich_click.COMMAND_GROUPS = { "*": [...], } @click.command("super-cool-tool") def main(): ... ``` You can also stick wildcards in the front, middle, or end of a key, e.g.: - `cli sub-command *` - `cli * sub-sub-command` - `* sub-command *` ??? note "Long example" ```python # foo.py import rich_click as click click.rich_click.OPTION_GROUPS = { "cli * c": [ { "name": "foo", "options": ["--flag1"] } ] } @click.group def cli(): ... @cli.group("x") @click.option("--flag1") @click.option("--flag2") def x(flag1, flag2): ... @x.command("a") @click.option("--flag1") @click.option("--flag2") def xa(flag1, flag2): ... @x.command("b") @click.option("--flag1") @click.option("--flag2") def xb(flag1, flag2): ... @x.command("c") @click.option("--flag1") @click.option("--flag2") def xc(flag1, flag2): ... @cli.group("y") @click.option("--flag1") @click.option("--flag2") def y(flag1, flag2): ... @y.command("a") @click.option("--flag1") @click.option("--flag2") def ya(flag1, flag2): ... @y.command("b") @click.option("--flag1") @click.option("--flag2") def yb(flag1, flag2): ... @y.command("c") @click.option("--flag1") @click.option("--flag2") def yc(flag1, flag2): ... @cli.group("z") @click.option("--flag1") @click.option("--flag2") def z(flag1, flag2): ... @z.command("a") @click.option("--flag1") @click.option("--flag2") def za(flag1, flag2): ... @z.command("b") @click.option("--flag1") @click.option("--flag2") def zb(flag1, flag2): ... @z.command("c") @click.option("--flag1") @click.option("--flag2") def zc(flag1, flag2): ... cli() ``` This works the way you'd expect: ```console $ python foo.py x c --help Usage: foo.py x c [OPTIONS] ╭─ foo ──────────────────────────────────────────────────────────────────────────────╮ │ --flag1 TEXT │ ╰────────────────────────────────────────────────────────────────────────────────────╯ ╭─ Options ──────────────────────────────────────────────────────────────────────────╮ │ --flag2 TEXT │ │ --help Show this message and exit. │ ╰────────────────────────────────────────────────────────────────────────────────────╯ $ python foo.py x b --help Usage: foo.py x b [OPTIONS] ╭─ Options ───────────────────────────────────────────────────────────────────────────╮ │ --flag1 TEXT │ │ --flag2 TEXT │ │ --help Show this message and exit. │ ╰─────────────────────────────────────────────────────────────────────────────────────╯ ``` #### `panel_styles` + Arguments panel styling The dicts for command+option groups now accept an optional `panel_styles` key, which passes kwargs to the `Panel()`. Another handy feature is that the "Arguments" panel (which is created when the config option `show_arguments` is `True`) can now be stylized through the API so long as the following is true: 1. `config.show_arguments` is `True`. 2. There is an option group with a `name` equal to the `config.arguments_panel_title` (default: `'Arguments'`) 3. The option group does not have any `options` (The list is empty, undefined, or `None`). Example: ```python hl_lines="8-11" import rich_click as click from rich import box help_config = click.RichHelpConfiguration( show_arguments=True, option_groups={ "my-command": [ { "name": "Arguments", "panel_styles": {"box": box.DOUBLE_EDGE, "border_style": "dim red"} } ] } ) @click.command("my-command") @click.argument("foo") @click.argument("bar") @click.option("--baz") @click.rich_config(help_config=help_config) def cli(foo, bar, baz): ... if __name__ == "__main__": cli() ``` {.screenshot} ### Improved performance During command execution, **rich-click** now loads faster and takes up less memory than before:   !!! info Python regularly compiles `.py` files into `.pyc` files to speed up code execution. The **with bytecode** metrics measure performance _with_ these `.pyc` files, and the **without bytecode** metrics measure performance _without_ them. We include the code we ran below. The metrics you see above were gathered by running the below script on an old Macbook. ??? note "Profiling script" This is the script we used to generate the data in the bar chart. This script requires `uv` and `gdate`. ```shell #!/bin/bash set -eo pipefail export VIRTUAL_ENV=.venv_benchmarks export PY_VERSION=3.12 speed_trials=40 mprof_trials=10 ############################################################################### uv venv "${VIRTUAL_ENV}" --python "${PY_VERSION}" cat <' ' (4 spaces).
The following code snippet demonstrates this:
```python
{% include "../code_snippets/text_markup_and_formatting/newline_control.py" %}
```
???+ example "Output"
{.screenshot}
Note that this differs from how base Click handles newlines.
The following is the same CLI help text but using `import click` instead of `import rich_click as click`:
??? example "Output - `import click` instead of `import rich_click as click`"
{.screenshot}
### Spacing
By default, **rich-click** renders double newlines as single newlines.
This is a deliberate decision to make help text take up less vertical space.
However, you can override this behavior by setting the config option `text_paragraph_linebreaks` to `"\n\n"`.
```python hl_lines="7"
{% include "../code_snippets/text_markup_and_formatting/newline_control_double.py" %}
```
???+ example "Output"
{.screenshot}
???+ info
This default behavior of collapsing newlines is not true when `text_markup='markdown'`.
For markdown, we do not do any newline manipulation.
rich-click-1.9.9/docs/documentation/themes.md 0000664 0000000 0000000 00000047006 15247065310 0021164 0 ustar 00root root 0000000 0000000 # Themes
**Themes** are a simple way to customize the style of CLI help text as both an end-user and as a developer.
Themes are one of **rich-click**'s most powerful features.
=== "`nord-nu`"
```shell
export RICH_CLICK_THEME=nord-nu
python docs/code_snippets/themes/cli.py --help
```
{.screenshot}
=== "`dracula-modern`"
```shell
export RICH_CLICK_THEME=dracula-modern
python docs/code_snippets/themes/cli.py --help
```
{.screenshot}
=== "`cargo-slim`"
```shell
export RICH_CLICK_THEME=cargo-slim
python docs/code_snippets/themes/cli.py --help
```
{.screenshot}
=== "`forest-robo`"
```shell
export RICH_CLICK_THEME=forest-robo
python docs/code_snippets/themes/cli.py --help
```
{.screenshot}
Themes consist of **Color Palettes** and **Formats**, which can be mixed and matched.
The name of a full theme has the following schema: `{color_palette}-{format}`.
For example, the **forest-slim** theme uses the **forest** color palette and the **slim** format.
??? info "Code for `cli.py`"
The following CLI code is used throughout this module to show off themes.
```python
{% include "../code_snippets/themes/cli.py" %}
```
## Themes as an end-user
Unless a developer specifies otherwise, every **rich-click** CLI can have a theme applied by an end-user by setting the `RICH_CLICK_THEME` env var.
If you'd like to set a global theme, add the following to your shell's config file (replacing `star-modern` with whatever theme you desire):
=== "bash"
```shell
echo "export RICH_CLICK_THEME=star-modern" >> ~/.bashrc
```
=== "zsh"
```shell
echo "export RICH_CLICK_THEME=star-modern" >> ~/.zshrc
```
Themes will also be used when you wrap a base Click CLI in the `rich-click` CLI, e.g.:
=== "Command"
```shell
export RICH_CLICK_THEME=star-modern
rich-click flask --help
```
=== "uv command"
```shell
export RICH_CLICK_THEME=star-modern
uv run --with=flask --with=rich-click \
rich-click flask --help
```
{.screenshot}
Alternatively, when using the `rich-click [cmd]` CLI, you can pass a theme via the `--theme`/`-t` option:
=== "Command"
```shell
rich-click -t star-slim flask --help
```
=== "uv command"
```shell
uv run --with=flask --with=rich-click \
rich-click --theme=star-slim flask --help
```
{.screenshot}
The `RICH_CLICK_THEME` env var can also be a full JSON representation of a config.
For example, let's say you prefer having commands above options. There is a config option for this, `commands_before_options`, and you can place that in the `RICH_CLICK_THEME` env var:
=== "Command"
```shell
export RICH_CLICK_THEME='{"commands_before_options": true, "theme": "red1-nu"}'
rich-click flask --help
```
=== "uv command"
```shell
export RICH_CLICK_THEME='{"commands_before_options": true, "theme": "red1-nu"}'
uv run --with=flask --with=rich-click \
rich-click flask --help
```
{.screenshot}
## Themes as a developer
You can set a theme for your CLI by setting it in the config:
=== "`{}`"
```python
import rich_click as click
@click.group("cli")
@click.rich_config({"theme": "nord-slim"})
def cli():
"""My CLI help text"""
```
=== "`RichHelpConfiguration()`"
```python
import rich_click as click
@click.group("cli")
@click.rich_config(click.RichHelpConfiguration(theme="nord-slim"))
def cli():
"""My CLI help text"""
```
=== "Global config"
```python
import rich_click as click
click.rich_click.THEME = "nord-slim"
@click.group("cli")
def cli():
"""My CLI help text"""
```
For more advanced CLIs, with lots of other customization options, there are additional considerations with themes and how they interact with your config that you may want to consider, especially in relation to end users being able to override the theme. For more information on this, read [the **Configuration** docs](configuration.md).
## All themes
### Formats
There are currently 5 available **formats**.
=== "`box`"
**(Default)** Original rich-click format with boxes.
{.screenshot}
=== "`slim`"
Simple, classic, no-fuss CLI format.
{.screenshot}
=== "`modern`"
Beautiful modern look.
{.screenshot}
=== "`robo`"
Spacious with sharp corners.
{.screenshot}
=== "`nu`"
Great balance of compactness, legibility, and style.
{.screenshot}
### Color palettes
There are currently over a dozen different **color palettes**.
#### Multi-colored palettes
=== "`default`"
**Default** Original rich-click colors.
```shell
export RICH_CLICK_THEME=default-box
python docs/code_snippets/themes/cli.py --help
```
{.screenshot}
=== "`solarized`"
Bright, colorful, vibrant accents.
```shell
export RICH_CLICK_THEME=solarized-box
python docs/code_snippets/themes/cli.py --help
```
{.screenshot}
=== "`nord`"
Many shades of cool colors.
```shell
export RICH_CLICK_THEME=nord-box
python docs/code_snippets/themes/cli.py --help
```
{.screenshot}
=== "`star`"
[Litestar](https://litestar.dev/) official theme.
```shell
export RICH_CLICK_THEME=star-box
python docs/code_snippets/themes/cli.py --help
```
{.screenshot}
=== "`quartz`"
Dark and radiant.
```shell
export RICH_CLICK_THEME=quartz-box
python docs/code_snippets/themes/cli.py --help
```
{.screenshot}
=== "`quartz2`"
Remix of 'quartz' with accents.
```shell
export RICH_CLICK_THEME=quartz2-box
python docs/code_snippets/themes/cli.py --help
```
{.screenshot}
=== "`cargo`"
Cargo CLI theme; legible and bold.
```shell
export RICH_CLICK_THEME=cargo-box
python docs/code_snippets/themes/cli.py --help
```
{.screenshot}
=== "`forest`"
Earthy tones with analogous colors.
```shell
export RICH_CLICK_THEME=forest-box
python docs/code_snippets/themes/cli.py --help
```
{.screenshot}
=== "`dracula`"
Vibrant high-contract dark theme.
```shell
export RICH_CLICK_THEME=dracula-box
python docs/code_snippets/themes/cli.py --help
```
{.screenshot}
!!! warning
The `dracula`, `nord`, and `solarized` themes use hex values,
and **rich-click** currently does not detect background colors for users' terminals.
So although these themes are beautiful and work well as an end-user with `export RICH_CLICK_THEME=`, this also makes these themes risky to use as a developer.
All of the other themes use ANSI colors exclusively, and therefore users' environments are more likely to match these themes well.
The `dracula`, `nord`, and `solarized` all have variants that force dark-backgrounds: `dracula_darkbg`, `nord_darkbg`, and `solarized_darkbg`.
You can apply this with something like [`term-background`](https://pypi.org/project/term-background/):
```python
import rich_click as click
from term_background import is_dark_background
if is_dark_background():
click.rich_click.THEME = "dracula"
else:
click.rich_click.THEME = "dracula_darkbg"
```
Some of these themes are riskier than others to apply as a developer. For example, the `solarized` theme is designed for both light and dark backgrounds. The `nord` theme has been tested on light terminals and, in practice, is legible. The `dracula` theme, however, is not user-friendly on a light background terminal.
Additionally, the `solarized` theme in particular is quite legible on both dark and light backgrounds,
so it is a relatively safe theme to use as a developer.
In a later version of **rich-click**, we intend on adding background color detection and styling conditional on background color,
which will make these themes safe to use as a developer.
#### Simple palettes
The following palettes all focus on just a single color.
The below palettes are presented with the `modern` format.
=== "`red1`"
Simple theme with red accents on section headers.
```shell
export RICH_CLICK_THEME=red1-modern
python docs/code_snippets/themes/cli.py --help
```
{.screenshot}
=== "`red2`"
Simple theme with red accents on object names.
```shell
export RICH_CLICK_THEME=red2-modern
python docs/code_snippets/themes/cli.py --help
```
{.screenshot}
=== "`green1`"
Simple theme with green accents on section headers.
```shell
export RICH_CLICK_THEME=green1-modern
python docs/code_snippets/themes/cli.py --help
```
{.screenshot}
=== "`green2`"
Simple theme with green accents on object names.
```shell
export RICH_CLICK_THEME=green2-modern
python docs/code_snippets/themes/cli.py --help
```
{.screenshot}
=== "`yellow1`"
Simple theme with yellow accents on section headers.
```shell
export RICH_CLICK_THEME=yellow1-modern
python docs/code_snippets/themes/cli.py --help
```
{.screenshot}
=== "`yellow2`"
Simple theme with yellow accents on object names.
```shell
export RICH_CLICK_THEME=yellow2-modern
python docs/code_snippets/themes/cli.py --help
```
{.screenshot}
=== "`blue1`"
Simple theme with blue accents on section headers.
```shell
export RICH_CLICK_THEME=blue1-modern
python docs/code_snippets/themes/cli.py --help
```
{.screenshot}
=== "`blue2`"
Simple theme with blue accents on object names.
```shell
export RICH_CLICK_THEME=blue2-modern
python docs/code_snippets/themes/cli.py --help
```
{.screenshot}
=== "`magenta1`"
Simple theme with magenta accents on section headers.
```shell
export RICH_CLICK_THEME=magenta1-modern
python docs/code_snippets/themes/cli.py --help
```
{.screenshot}
=== "`magenta2`"
Simple theme with magenta accents on object names.
```shell
export RICH_CLICK_THEME=magenta2-modern
python docs/code_snippets/themes/cli.py --help
```
{.screenshot}
=== "`cyan1`"
Simple theme with cyan accents on section headers.
```shell
export RICH_CLICK_THEME=cyan1-modern
python docs/code_snippets/themes/cli.py --help
```
{.screenshot}
=== "`cyan2`"
Simple theme with cyan accents on object names.
```shell
export RICH_CLICK_THEME=cyan2-modern
python docs/code_snippets/themes/cli.py --help
```
{.screenshot}
#### Monochromatic palettes
The following palettes have zero color.
=== "`mono`"
Monochromatic theme with no colors.
```shell
export RICH_CLICK_THEME=mono-box
python docs/code_snippets/themes/cli.py --help
```
{.screenshot}
=== "`plain`"
No style at all.
```shell
export RICH_CLICK_THEME=plain-box
python docs/code_snippets/themes/cli.py --help
```
{.screenshot}
??? example "`plain-slim`"
Of course, the most plain style of them all is `plain-slim`, which renders CLI help text in the most conventional way that **rich-click** can.
For fun, we've included it here!
(Or, maybe you really dislike **rich-click**'s styles and you want to add `export RICH_CLICK_THEME=plain-slim` to your `.zshrc`.
We won't judge!)
```shell
export RICH_CLICK_THEME=plain-slim
python docs/code_snippets/themes/cli.py --help
```
{.screenshot}
### List all themes in command line
Running `rich-click --themes` will provide help text that lists every theme available to you.
The command will also tell you which theme you currently have enabled.
??? info "Output of `rich-click --themes`"
{.screenshot}
rich-click-1.9.9/docs/documentation/typer_support.md 0000664 0000000 0000000 00000003463 15247065310 0022635 0 ustar 00root root 0000000 0000000 # Typer Support
!!! error "Experimental"
For now, Typer patching support does not work with `typer>=0.26.0`.
Please use an older version of Typer if you'd like to use `patch_typer()`.
!!! example "Experimental"
This feature is still experimental.
Please report any bugs or issues you run into!
You don't need to use **rich-click** directly to get access to a lot of **rich-click**'s great features.
If you are a fan of Typer and you'd like to use **rich-click**'s themes, you can patch Typer to use **rich-click**
and set the global config's `THEME` (and other config options) to whatever you want.
All you need to do is import `patch_typer()` from `rich_click.patch`.
This does not need to be done at the top of the file, in fact you can do it right before calling `app.run()` or `typer.run(...)`:
```python hl_lines="24-28"
{% include "../code_snippets/typer_support/typer_example.py" %}
```
???+ example "Output"
Running the above Typer CLI works the same as you would otherwise expect,
except now with a **rich-click** theme applied:
{.screenshot}
## Patching Typer via the `rich-click` CLI
You can also patch Typer as an end-user of any Typer CLI via the `rich-click` CLI.
```shell
rich-click my-typer-cli --help
```
In addition to giving access to **rich-click**'s themes, another benefit of this is being able to generate HTML and SVG help text easily.
Although, do note that Typer and **rich-click** have some minor differences in how they render help text.
More information about usage of the `rich-click` CLI is in [the **rich-click CLI** docs](rich_click_cli.md), or you can run **`rich-click --help`** to view the CLI.
rich-click-1.9.9/docs/editor.md 0000664 0000000 0000000 00000000167 15247065310 0016311 0 ustar 00root root 0000000 0000000 ---
title: Live Style Editor
hide:
- toc
- navigation
---
rich-click-1.9.9/docs/fonts/ 0000775 0000000 0000000 00000000000 15247065310 0015626 5 ustar 00root root 0000000 0000000 rich-click-1.9.9/docs/fonts/LICENSE 0000664 0000000 0000000 00000001213 15247065310 0016630 0 ustar 00root root 0000000 0000000 pixelmix
Copyright (c) Andrew Tyler 2010
https://andrewtyler.gumroad.com/l/pixelmix
PixelMix is free for personal use. For commercial use, including apps, a commercial license is required. Upon payment of the nonrefundable license fee, you are granted you a nonexclusive, nontransferable, limited right to use the Font Software according to the included EULA.
Font EULA:
https://docs.google.com/document/d/e/2PACX-1vRZasbum7bxVI7iCptrs99OgFTM5iOtGCC4gGjlC-2g4F9Q4uRv_O8ktPBsmibUFs-Bbi2wAZo1Lyaa/pub
Webfont EULA:
https://docs.google.com/document/d/e/2PACX-1vTw12GLAP2uPQROo0nSWfNyH9n3_0zHykfCJINlwr553jN4JgfDlRyeZvnVi-7CNUvEaavXqZS2bbpj/pub
rich-click-1.9.9/docs/fonts/pixelmix.ttf 0000664 0000000 0000000 00000053250 15247065310 0020211 0 ustar 00root root 0000000 0000000
PFFTM\b V GDEF $ Vd (OS/2fw X `cmapo @ gasp V\ glyf 8 8@head7 6hhea $hmtx locaș0
Hmaxp & 8 nameCX Fx post,K L
P Z$M_< O O $ 3 @
FSTR @
~ xO & : !"
x & 9 !" JC|{vd~
! " # $ % & ' ( ) * + , - . / 0 1 2 3 4 5 6 7 8 9 : ; < = > ? @ A B C D E F G H I J K L M N O P Q R S T U V W X Y Z [ \ ] ^ _ ` a r d e i x p k v j s g w l | c n m } b y q z 2 ` 8Zn8h0\n Jh 8Lj4f 0l$6Vz @ Z x
2
R
r
P p , 8 D X d p
"
@
L
X
d
p
|
(4@LXdp| P\ht (4@LXdp|&2>JVbnz
".:FR^jv *6BNZfr~&2>JVbnz
".:FR^jv *6BNZfr~&2>JVbnz
".:FR^jv *6BNZfr~&2>JVbnz
$2>J^r~ 1! 1533 333 #5#53#53533533#3##5# # =3!33%5353#53#5!#3#3 153!!%35353%!%53 # 35!353%53!375!353%53%!## 3 !53%53%353=3 153=35353%53 5#53533# %!5!3!! 35#5! 5! 1! 1333 35!5333#!#53535! 153#53533 15353!53=35335! 35!%53!353%53=!5!# 53!3!#53533# 35!%53!3!!! 35!53!3!!53=! 3353=3=!5! 35!%3!35!%3!35! 35!=335!5!35! =353 35#5!53 !53%53%53%53=3=3=3 5!5! 153=3=3=3%53%53%53 35353=35335! 35!5#37!335! 13!3#!5! %33!!!!! 35!=3!353%5! %3!!! 1!!!!! 1!!!! 35!!5!%353%5! 13!3#! 153#5!#3 35!%53!#5!# !53%53%5353=333#53 13! 333#!#5353 5333#!#533 35!%3!35!
3!!!! 35!353%53%533%35! !53%533!!!##5# 15!535!%35! !!5!! 35!%3!3 !53%3333!3 353353%3!3!3 # 13!353353%53%53353%3!3 !353353%3!3
13!53=3=3=!5! 1!#3 !333 153#5! 53!53%53353%53 15! 53%53
=3 5!5!5!535! %35!33#! 35!=3!35! 535!5!#533
35!%3!53!5! 3#5333#53%5! 35!35!5!!5! !35!33#
153#5!353 35!%53!353 !53%5353=333# 153#5!3
33!!#53 !3!33#5! 35!%3!35!
53!!!! 53=!!5!5353 5333#5! 15!=3%5!%53=! !5!=3!#5333# 35!%3!3 !53%53353%3!3 353353%3!3!3 # 153!53%53353%53%53353%53!53 35!35!5!3 15353!53=!5!# 333535!# 13 153353%#5! 53%53353353%53 15! 1! 1! 1! 1! 1! 133 1! 1! 35!!#33!35! 1! 353!53%53!53%53!53 1! 5! 1! 5! 5!%3!35! 15!!5!3!! 1! 1! 1! 1! 1! 53 1! 1! 1! 153!53%53!53%53!53 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! # 153!53%53353%53%53353%53!53 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! !535!53 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 1! 5! 3 3 1! 1! 333 333 1! !!5!3!! 153353353 !53%53%53=3=3 153=3=3%53%53 1! 1! 1! 1! V 0 b + l @
% 4 ) ` V J } 4
4[
J h R C o p y r i g h t A n d r e w T y l e r 2 0 1 2
f o n t @ a n d r e w t y l e r . n e t Copyright Andrew Tyler 2012
font@andrewtyler.net p i x e l m i x pixelmix R e g u l a r Regular F o n t F o r g e 2 . 0 : p i x e l m i x R e g u l a r : 1 - 2 - 2 0 1 2 FontForge 2.0 : pixelmix Regular : 1-2-2012 p i x e l m i x R e g u l a r pixelmix Regular V e r s i o n 1 . 0 Version 1.0 p i x e l m i x pixelmix A n d r e w T y l e r Andrew Tyler A n d r e w T y l e r Andrew Tyler h t t p : / / w w w . a n d r e w t y l e r . n e t http://www.andrewtyler.net h t t p : / / w w w . a n d r e w t y l e r . n e t http://www.andrewtyler.net C r e a t i v e C o m m o n s A t t r i b u t i o n B Y N C N D Creative Commons Attribution BY NC ND h t t p : / / c r e a t i v e c o m m o n s . o r g / l i c e n s e s / b y - n c - n d / 3 . 0 / u s / http://creativecommons.org/licenses/by-nc-nd/3.0/us/ F i v e b i g q u a c k i n g z e p h y r s j o l t m y w a x b e d Five big quacking zephyrs jolt my wax bed e 3
! " # $ % & ' ( ) * + , - . / 0 1 2 3 4 5 6 7 8 9 : ; < = > ? @ A B C D E F G H I J K L M N O P Q R S T U V W X Y Z [ \ ] ^ _ ` a b c d e f g h j i k m l n o q p r s u t v w x z y { } | ~
!"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~ glyph1uni000Duni00A0uni00ADuni00B2uni00B3uni00B5uni00B9uni0180uni0181uni0182uni0183uni0184uni0185uni0186uni0187uni0188uni0189uni018Auni018Buni018Cuni018Duni018Euni018Funi0190uni0191uni0193uni0194uni0195uni0196uni0197uni0198uni0199uni019Auni019Buni019Cuni019Duni019Euni019FOhornohornuni01A2uni01A3uni01A4uni01A5uni01A6uni01A7uni01A8uni01A9uni01AAuni01ABuni01ACuni01ADuni01AEUhornuhornuni01B1uni01B2uni01B3uni01B4uni01B5uni01B6uni01B7uni01B8uni01B9uni01BAuni01BBuni01BCuni01BDuni01BEuni01BFuni01C0uni01C1uni01C2uni01C3uni01C4uni01C5uni01C6uni01C7uni01C8uni01C9uni01CAuni01CBuni01CCuni01CDuni01CEuni01CFuni01D0uni01D1uni01D2uni01D3uni01D4uni01D5uni01D6uni01D7uni01D8uni01D9uni01DAuni01DBuni01DCuni01DDuni01DEuni01DFuni01E0uni01E1uni01E2uni01E3uni01E4uni01E5Gcarongcaronuni01E8uni01E9uni01EAuni01EBuni01ECuni01EDuni01EEuni01EFuni01F0uni01F1uni01F2uni01F3uni01F4uni01F5uni01F6uni01F7uni01F8uni01F9
Aringacute
aringacuteAEacuteaeacute Oslashacute oslashacuteuni0200uni0201uni0202uni0203uni0204uni0205uni0206uni0207uni0208uni0209uni020Auni020Buni020Cuni020Duni020Euni020Funi0210uni0211uni0212uni0213uni0214uni0215uni0216uni0217 Scommaaccent scommaaccentuni021Auni021Buni021Cuni021Duni021Euni021Funi0220uni0221uni0222uni0223uni0224uni0225uni0226uni0227uni0228uni0229uni022Auni022Buni022Cuni022Duni022Euni022Funi0230uni0231uni0232uni0233uni0234uni0235uni0236uni0237uni0238uni0239uni023Auni023Buni023Cuni023Duni023Euni023Funi0240uni0241uni0242uni0243uni0244uni0245uni0246uni0247uni0248uni0249uni024Auni024Buni024Cuni024Duni024Euni024F
quotereversedEurouniFB01uniFB02 ɉo1 t O c rich-click-1.9.9/docs/images/ 0000775 0000000 0000000 00000000000 15247065310 0015742 5 ustar 00root root 0000000 0000000 rich-click-1.9.9/docs/images/arguments.svg 0000664 0000000 0000000 00000047464 15247065310 0020507 0 ustar 00root root 0000000 0000000
rich-click-1.9.9/docs/images/blog/ 0000775 0000000 0000000 00000000000 15247065310 0016665 5 ustar 00root root 0000000 0000000 rich-click-1.9.9/docs/images/blog/five-pre-made-styles/ 0000775 0000000 0000000 00000000000 15247065310 0022627 5 ustar 00root root 0000000 0000000 rich-click-1.9.9/docs/images/blog/five-pre-made-styles/example-1.svg 0000664 0000000 0000000 00000027631 15247065310 0025152 0 ustar 00root root 0000000 0000000
rich-click-1.9.9/docs/images/blog/five-pre-made-styles/example-2-dark.png 0000664 0000000 0000000 00000056330 15247065310 0026055 0 ustar 00root root 0000000 0000000 PNG
IHDR J ۉv \IDATx^Wp Iz{"
]HS⌣Ё{Ёw ɡwAOs~8fwoe֯#i?#iff@&Uw:C3zim>lHz@] 53Qt~μz`8$dz|H#*Fӹ~zYs-@ v\@Irì o3eoڀ ̰?1 vls/LNl;};|j)PjYmF\;!Rb=wz
LՍGL20 Q
YQb5rψ^Vq@ى 2Et! #8F6(Y/юM 11JuC0fyM V M.ݮjpɥlGe qImw=81xO%xqkm.2Z"β}
1yoLQEvyBaaGjqnk QxV1[0_ d;_C)VF1Asa0B+iq[Џ(a _Mɬ A֪G/ yp
qb%?Y-y !F?vK*f# 齻`[Ҵ*(ڭD0KʹqA;sFڝ1ӎň13H 3A Eȕ Fب*^+^ cF50ŲjǎG!uA@X '.c
YP;KMoAN|kx<+ V%jA)!ث`L]{Z
lݲY^.˘`T־9
\q`Z\Ycx0_vI^X Ȭve|&r
;[S],`|Ʒj'jPcBwdUcATCʴ+L Dַiޞ紆kДf iޣ Zq&1QSm~ބWe5^rmuԪ ]`f 0CH*u@yBE # זO!9uQ{= sƲ4\E4Soles в(<H :wbh a' V.
}@1 8v)&_ )'h n=*ut;IYV](l DWuA1ؔB*av] F*Zt`x5YFh+7(Fn}Y(UKߣE|.F}]}@H ,BBX|[-gFClJ*g4hSpՉؠBr=F3,2ltY}O %{ ZYF)˫d {.~j11u d/c )l V7Sзo(pTQg3jځqQ8:٣oR}5rP~ #NR
9vrF{z^ [ФaZ ~F&Pi CIre XN
V^dOvk4)>`}Yk}j{ ʀq s߆TEڭn{y[62fq4)ɹHQ>Xۖ/ܱnֈ^dRxx|%ߨԋt퀱o/|Æ_rlY5GE`*h- 7nhnɯpi2G2 [{MZ6 Cx#FF-yv 7
G#W5Eگ ~bqm_ќWPjI։
+mne
FaG*}!aR !'>4JI9WeNRCEP%08wNAQb*Q1U@̣E{ZzWB;?Eۇ4ԯ "͚vڭZxqs8hjGQa%3lr%ՁbGf_ܒ:# N]ї!eIʓoOqԛ8+;` ^7): PO- 莟=IcWwс7wޛV17q]uOOj ?^ nYe߭+>W}~$;9پ+s?Hu˺6& R^~ $-/ٰ~=p8ke/>o_\ZaO Iد&okřn_{jkD|fWװ?Y?̶e#wvݟfk~Ò |Aܹm=kgyyˠڵkg'xvm_az9.} H`Y[(|O{ƭWzO]{/coݿU|e.
]{0[nc2kmx{Q_="Mq MSBXzV6V+.R鐹}k Pk܂a{&DK$6N L?9Cm[? E?hdп#Ş }nJc0э7z~':$`b}Eg&=?2_=kBm
1=|Jo!zx&GSs;" Nǎx*Z>ѣ0mCqo=PYLrUr *^Hb~WT!~uBLR,NIbqNLU=oڿDnXCZwA?Ssĝx*x/\pŞ}B&dtlP$#= `
T|uE+T U$IV ORI-sAXrM'x ؓT#U,H uuUǓTjuRE \ U/p{-d _@u` _@wr}hXHSZu&ly e+ 7 -u
lp)sR:ޜj7 Lωۘ|)
̛SxS˜0eUN[Xم" " G9E}dqo+*8aG
ΊOi;jt |MיT]RS?] w " je[Df|SQɉcsפ:.(2FpMөRD @hz<+J+XZ\/Z01%oiN a}-D'@D Xx)Ks_V!vvf2` Oq67HJ@D Ht+*-gMf._覣}j R.fx9> DFb " ʕ+/ΚB NwjC;iNf3c}hz@D@T̙S:% @EpퟖN>5U[$/k ?w@D@3)++ ,;k˝w"L+ş"^\dߠ/: j "6YD.(ϧwt_IxgG2%|BD @#дi©/rJ +gJgjVhYuܵ5ZZ:`Vegm )V h;e# nW" WL 6[wT;wv=4ٜrVgk zw5 4%9Y}-!U^TP~OcmgK[ʭr4B ~4#%?S:D0 >bdjApJ"hP% @JԴ. J̤0< ~ՋOz9z;(1ik@Mw7OfTE >);A @H9Tb0.1SDE 1/=ye{c]j?
"x /D/az`oApU"hP '0.1KF 6Ji/ 9ta9N y7D/0 ;" '"
ZA(vO%pP(qk|)_?c/ xܷ3 ?ގO`=v OB>L͑=
0J}jdj] C`<l% ?92r"! ("* uxv
ZA(6
S@8EUQTb#p3cCtb>]:462c?1x S)L)Dk9Sc@.Ta#ϊttG*ConyxȜ"Q%eOI5pav
Z\$ vMmIAs"X5:c02vڣl7f)<+:Q9σ0?yhbM**HGy~QJ*cA*65mUMVbU Q!꾧S - akQh喢3[)lk]Ű/w O?{;B˝$y5 T#}8|jcr;;`E$V)y =y+Kw6Պ .ty9*kwHe zn@*xY1fBUQ2<:-®WE Gj 1?iN2<\ѻ5CMƠ
v<@Ǿzo]_W)x" OcK; a E X< F0=*iТܖRG XXא $ 8r!_ ocv҅7yKfHE2Id` @.aR 92/4'}*$vo
K
m9(AbA0- !' DC{zgHuu @RE}$u
N8 Z_=@`+7HD^lΕI"C>5s WI~)~&T=Ϋ9ozH:0۹[blKi