shtab
What: Automatically generate shell tab completion scripts for Python CLI apps
Why: Speed & correctness. Alternatives like argcomplete and pyzshcomplete are slow and have side-effects
How: shtab processes an argparse.ArgumentParser object to generate a tab completion script for your shell
Features
Outputs tab completion scripts for
bash
zsh
tcsh
fish
Supports
Supports arguments, options and subparsers
Supports choices (e.g. --say={hello,goodbye})
Supports file and directory path completion
Supports custom path completion (e.g. --file={*.txt})
Installation
Choose one of:
pip install shtab, or
conda install -c conda-forge shtab
Usage
There are two ways of using shtab:
CLI Usage: shtab’s own CLI interface for external applications
may not require any code modifications whatsoever
end-users execute shtab your_cli_app.your_parser_object
Library Usage: as a library integrated into your CLI application
adds a couple of lines to your application
argument mode: end-users execute your_cli_app --print-completion {bash,zsh,tcsh,fish}
subparser mode: end-users execute your_cli_app completion {bash,zsh,tcsh,fish}
Examples
FAQs
Not working? Check out frequently asked questions.
Alternatives
-
executes the underlying script every time <TAB> is pressed (slow and has side-effects)
-
executes the underlying script every time <TAB> is pressed (slow and has side-effects)
only provides zsh completion
-
different framework completely replacing the builtin argparse
solves multiple problems (rather than POSIX-style “do one thing well”)
Contributions
Please do open issues & pull requests! Some ideas:
support powershell (#212)
support python -m prefix (#55)
See CONTRIBUTING.md for more guidance.
4 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file shtab-1.9.2.tar.gz.
File metadata
- Download URL: shtab-1.9.2.tar.gz
- Upload date:
- Size: 49.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/7.0.0 CPython/3.14.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8f9ef33e1c89d6c294c9bd8fc5c0d661892054a60f7ab9c909e80302061f2a3f
|
|
| MD5 |
53d8667e466f42f3ad6d7a0bddfd9c6a
|
|
| BLAKE2b-256 |
fc67179150085f25bb5435ed81befd9a0152764b3bb1b1167f7625fc320d9c56
|
Provenance
The following attestation bundles were made for shtab-1.9.2.tar.gz:
Publisher:
test.yml on tqdm/shtab
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
shtab-1.9.2.tar.gz -
Subject digest:
8f9ef33e1c89d6c294c9bd8fc5c0d661892054a60f7ab9c909e80302061f2a3f - Sigstore transparency entry: 2306149362
- Sigstore integration time:
-
Permalink:
tqdm/shtab@da00543b3ed806f546b02905b6cde7390e7c55ad -
Branch / Tag:
refs/tags/v1.9.2 - Owner: https://github.com/tqdm
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
test.yml@da00543b3ed806f546b02905b6cde7390e7c55ad -
Trigger Event:
push
-
Statement type:
File details
Details for the file shtab-1.9.2-py3-none-any.whl.
File metadata
- Download URL: shtab-1.9.2-py3-none-any.whl
- Upload date:
- Size: 15.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/7.0.0 CPython/3.14.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0b2f15f239de932b0d544519ca9b62608d6e2c38840e697dcc14b7a4e282d6e2
|
|
| MD5 |
ff9b020293f8232740afd7f9a39f7cb2
|
|
| BLAKE2b-256 |
e80f3e783ec50e47a63d8b8e3be6b75d1115e8fd8e1f78c6e8b83ae4d4ad686e
|
Provenance
The following attestation bundles were made for shtab-1.9.2-py3-none-any.whl:
Publisher:
test.yml on tqdm/shtab
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
shtab-1.9.2-py3-none-any.whl -
Subject digest:
0b2f15f239de932b0d544519ca9b62608d6e2c38840e697dcc14b7a4e282d6e2 - Sigstore transparency entry: 2306149284
- Sigstore integration time:
-
Permalink:
tqdm/shtab@da00543b3ed806f546b02905b6cde7390e7c55ad -
Branch / Tag:
refs/tags/v1.9.2 - Owner: https://github.com/tqdm
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
test.yml@da00543b3ed806f546b02905b6cde7390e7c55ad -
Trigger Event:
push
-
Statement type:
