shell-complete

WARNING

This project never came out of the development phase. It's not recommended for usage.

• package: https://pypi.org/project/shell-complete/
• docs (see source)
• source: https://github.com/utility-libraries/shell-complete-py

---

Library README scraped 2024-03-11

shell-complete-py

python package to generate shell-completion for your CLI

Warning: This project is in the earliest phase possible

Installation

pip3 install shell-complete

Usage

Either import and use the generate(parser: ArgumentParser) function or directly the ActionGenerate

from argparse import ArgumentParser
from shell_complete import ActionShellComplete, types

parser = ArgumentParser()
...
# creates the --completion argument that's similar to --help or --version
# --completion print : prints the script for the user to handle it himself
# --completion install : creates script in ~/.bash_completion.d/ and `source <script>` in ~/.bashrc
# --completion uninstall : removes script in ~/.bash_completion.d/ and `source <script>` in ~/.bashrc
parser.add_argument('--completion', action=ActionShellComplete,
                    help="Generate a bash-completion-script")
...
# smart autocompletion
parser.add_argument('--source', type=types.file)
parser.add_argument('--bind', type=types.ip_address)
parser.add_argument('--database', type=types.known_hosts)

You can also execute the module itself

python3 -m shell_complete [args...]

Or run the console-script

shell-complete [args...]

---