click-extra
🌈 Drop-in replacement for Click to make user-friendly and colorful CLI
Science Score: 67.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 3 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.2%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
🌈 Drop-in replacement for Click to make user-friendly and colorful CLI
Basic Info
- Host: GitHub
- Owner: kdeldycke
- License: gpl-2.0
- Language: Python
- Default Branch: main
- Homepage: https://kdeldycke.github.io/click-extra
- Size: 19.2 MB
Statistics
- Stars: 96
- Watchers: 2
- Forks: 8
- Open Issues: 17
- Releases: 97
Topics
Metadata Files
readme.md
What is Click Extra?
It should be easy to write a good CLI in Python. Click makes it so. But there is still hundrends of tweaks to implement by yourself to have a user-friendly CLI.
Click Extra is a ready-to-use wrapper around Click to make your CLI look good and behave well. It is a drop-in replacement with good defaults that saves lots of boilerplate code and frustration by making all parts working together.
It also comes with workarounds and patches that have not reached upstream yet (or are unlikely to).
Example
It transforms this vanilla click CLI:

Into this:

To undestrand how we ended up with the result above, go read the tutorial.
Features
- Configuration file loader for:
TOMLYAMLJSONINI, with extended interpolation, multi-level sections and non-native types (list,set, …)XML
- Automatic inference of the configuration file structure from your CLI's options
- Remote loading of configuration from URLs
- Optional strict validation of configuration
- Respect the default application path on each platform (XDG spec. on Linux)
- Glob search patterns for configuration files
- A
--no-configoption to disable configuration file loading - Respect of
CLI>Configuration>Environment>Defaultsprecedence - Normalization and discoverability of environment variables
--show-paramsoption to debug parameters defaults, values, environment variables and provenance- Click parameters introspection
- Colorization of help screens at the semantic-level of options, parameters, subheadings, choices, metavars and defaults
- Global
show_envvaroption to display all environment variables in help screens -h/--helpoption names (see rant on other inconsistencies)--color/--no-coloroption flag--telemetry/--no-telemetryflag to opt-in/out of tracking code- Recognize traditional environment variable conventions:
NO_COLORfromno-color.orgDO_NOT_TRACKfromconsoledonottrack.com
- Colored
--versionoption - Colored
--verbosityoption and logs --time/--no-timeflag to measure duration of command execution- Global
show_choicesto activate selection of choices on user input prompts click:exampleandclick:runSphinx directives in MyST Markdown and reStructuredText to document CLI source code and their execution- Inline testing of CLI examples in documentation
- ANSI-capable Pygments lexers for shell session and console output
- Fixes 50+ bugs from other Click-related projects
- Rely on Cloup to add:
- option groups
- constraints
- subcommands sections
- aliases
- command suggestion (
Did you mean <subcommand>?)
Used in
Check these projects to get real-life examples of click-extra usage:
Meta Package Manager - A unifying CLI for multiple package managers.
Mail Deduplicate - A CLI to deduplicate similar emails.
fireproxng - A rewrite of the fireprox tool.
agent-catalog - Couchbase agent catalog.
badger-proxy - An mDNS-based reverse proxy for naming services on a local network.
Feel free to send a PR to add your project in this list if you are relying on Click Extra in any way.
Development
Development guidelines
are the same as
parent project mpm, from
which click-extra originated.
Owner
- Name: Kevin Deldycke
- Login: kdeldycke
- Kind: user
- Location: ☁︎
- Website: https://kevin.deldycke.com
- Repositories: 68
- Profile: https://github.com/kdeldycke
Entrepreneur, VP, Engineering Manager, Founding Engineer - Billing, Payments & IAM.
Citation (citation.cff)
cff-version: 1.2.0
title: "Click Extra"
message: "If you use this software, please cite it as below."
type: software
authors:
- family-names: "Deldycke"
given-names: "Kevin"
email: kevin@deldycke.com
orcid: "https://orcid.org/0000-0001-9748-9014"
doi: 10.5281/zenodo.7116050
version: 5.2.0
# The release date is kept up to date by the external workflows. See:
# https://github.com/kdeldycke/workflows/blob/33b704b489c1aa18b7b7efbf963e153e91e1c810/.github/workflows/changelog.yaml#L135-L137
date-released: 2025-08-25
url: "https://github.com/kdeldycke/click-extra"
GitHub Events
Total
- Create event: 142
- Issues event: 8
- Release event: 20
- Watch event: 27
- Delete event: 131
- Issue comment event: 240
- Push event: 1,516
- Pull request event: 331
- Fork event: 2
Last Year
- Create event: 142
- Issues event: 8
- Release event: 20
- Watch event: 27
- Delete event: 131
- Issue comment event: 240
- Push event: 1,516
- Pull request event: 331
- Fork event: 2
Committers
Last synced: 12 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Kevin Deldycke | k****n@d****m | 1,794 |
| GitHub Actions | a****s@g****m | 367 |
| Ross Smith II | r****s@s****m | 13 |
| github-actions[bot] | 4****] | 4 |
| Jakob | g****t@t****t | 3 |
| Raj | r****h@p****m | 1 |
| Kian-Meng Ang | k****g@c****g | 1 |
| BD103 | 5****3 | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 4 months ago
All Time
- Total issues: 72
- Total pull requests: 1,071
- Average time to close issues: about 1 month
- Average time to close pull requests: 10 days
- Total issue authors: 17
- Total pull request authors: 7
- Average comments per issue: 1.25
- Average comments per pull request: 0.94
- Merged pull requests: 648
- Bot issues: 44
- Bot pull requests: 1,057
Past Year
- Issues: 8
- Pull requests: 362
- Average time to close issues: 9 days
- Average time to close pull requests: 9 days
- Issue authors: 7
- Pull request authors: 4
- Average comments per issue: 2.13
- Average comments per pull request: 0.62
- Merged pull requests: 181
- Bot issues: 2
- Bot pull requests: 359
Top Authors
Issue Authors
- github-actions[bot] (44)
- kdeldycke (6)
- rasa (4)
- dependabot[bot] (3)
- gsemet (2)
- isezen (2)
- jasondamour (2)
- MePsyDuck (2)
- andreby (1)
- wangjinbei (1)
- johanneskastl (1)
- danigm (1)
- MrClock8163 (1)
- themoep (1)
- mrevoir (1)
Pull Request Authors
- dependabot[bot] (560)
- github-actions[bot] (557)
- rasa (10)
- themoep (1)
- dia38 (1)
- isezen (1)
- kdeldycke (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 2
-
Total downloads:
- pypi 15,788 last-month
-
Total dependent packages: 6
(may contain duplicates) -
Total dependent repositories: 8
(may contain duplicates) - Total versions: 192
- Total maintainers: 1
pypi.org: click-extra
🌈 Drop-in replacement for Click to make user-friendly and colorful CLI
- Homepage: https://github.com/kdeldycke/click-extra
- Documentation: https://kdeldycke.github.io/click-extra
- License: GNU General Public License v2 or later (GPLv2+)
-
Latest release: 5.1.1
published 4 months ago
Rankings
Maintainers (1)
Funding
- https://github.com/sponsors/kdeldycke
proxy.golang.org: github.com/kdeldycke/click-extra
- Documentation: https://pkg.go.dev/github.com/kdeldycke/click-extra#section-documentation
- License: gpl-2.0
-
Latest release: v5.1.1+incompatible
published 4 months ago
Rankings
Dependencies
- alabaster 0.7.12 develop
- atomicwrites 1.4.1 develop
- attrs 22.1.0 develop
- babel 2.10.3 develop
- beautifulsoup4 4.11.1 develop
- bump2version 1.0.1 develop
- coverage 6.4.3 develop
- decopatch 1.4.10 develop
- docutils 0.18.1 develop
- furo 2022.6.21 develop
- imagesize 1.4.1 develop
- iniconfig 1.1.1 develop
- jinja2 3.1.2 develop
- makefun 1.14.0 develop
- markdown-it-py 2.1.0 develop
- markupsafe 2.1.1 develop
- mdit-py-plugins 0.3.0 develop
- mdurl 0.1.1 develop
- myst-parser 0.18.0 develop
- packaging 21.3 develop
- pallets-sphinx-themes 2.0.2 develop
- pluggy 1.0.0 develop
- py 1.11.0 develop
- pyparsing 3.0.9 develop
- pytest 7.1.2 develop
- pytest-cases 3.6.13 develop
- pytest-cov 3.0.0 develop
- pytest-httpserver 1.0.5 develop
- pytest-randomly 3.12.0 develop
- pytz 2022.1 develop
- snowballstemmer 2.2.0 develop
- soupsieve 2.3.2.post1 develop
- sphinx 5.1.1 develop
- sphinx-autodoc-typehints 1.19.1 develop
- sphinx-basic-ng 0.0.1a12 develop
- sphinx-copybutton 0.5.0 develop
- sphinx-design 0.2.0 develop
- sphinx-issues 3.0.1 develop
- sphinxcontrib-applehelp 1.0.2 develop
- sphinxcontrib-devhelp 1.0.2 develop
- sphinxcontrib-htmlhelp 2.0.0 develop
- sphinxcontrib-jsmath 1.0.1 develop
- sphinxcontrib-qthelp 1.0.3 develop
- sphinxcontrib-serializinghtml 1.1.5 develop
- sphinxext-opengraph 0.6.3 develop
- types-tabulate 0.8.11 develop
- types-xmltodict 0.13.0 develop
- werkzeug 2.2.1 develop
- boltons 21.0.0
- certifi 2022.6.15
- charset-normalizer 2.1.0
- cli-helpers 2.2.1
- click 8.1.3
- click-log 0.4.0
- cloup 1.0.0
- colorama 0.4.5
- commentjson 0.9.0
- configobj 5.0.6
- idna 3.3
- importlib-metadata 4.12.0
- lark-parser 0.7.8
- mergedeep 1.3.4
- pygments 2.12.0
- pygments-ansi-color 0.0.6
- pyyaml 6.0
- regex 2022.7.25
- requests 2.28.1
- six 1.16.0
- tabulate 0.8.10
- tomli 2.0.1
- typing-extensions 4.3.0
- urllib3 1.26.11
- wcwidth 0.2.5
- xmltodict 0.13.0
- zipp 3.8.1
- Pallets-Sphinx-Themes ^2.0.2 develop
- bump2version ^1.0.1 develop
- coverage ^6.4 develop
- furo ^2022.6.21 develop
- myst-parser ^0.18.0 develop
- pytest ^7.1.2 develop
- pytest-cases ^3.6.13 develop
- pytest-cov ^3.0.0 develop
- pytest-httpserver ^1.0.3 develop
- pytest-randomly ^3.12.0 develop
- sphinx ^5.0.2 develop
- sphinx-autodoc-typehints ^1.18.3 develop
- sphinx-copybutton ^0.5.0 develop
- sphinx-design ^0.2.0 develop
- sphinx-issues ^3.0.1 develop
- sphinxext-opengraph ^0.6.3 develop
- types-tabulate ^0.8.11 develop
- types-xmltodict ^0.13.0 develop
- typing-extensions ^4.3.0 develop
- boltons ^21.0.0
- cli-helpers ^2.2.0
- click ^8.1.1
- click-log ^0.4.0
- cloup ^1.0.0
- commentjson ^0.9.0
- mergedeep ^1.3.4
- pygments ^2.10.0
- pygments-ansi-color ^0.0.6
- python ^3.7
- pyyaml ^6.0.0
- regex ^2022.3.15
- requests ^2.27.1
- tabulate ^0.8.9
- tomli ^2.0.1
- xmltodict >=0.12,<0.14
- actions/checkout v3.3.0 composite
- actions/setup-python v4.5.0 composite
- peter-evans/create-pull-request v4.2.3 composite
- actions/checkout v3.3.0 composite
- actions/setup-python v4.5.0 composite
- codecov/codecov-action v3.1.1 composite