Skip to main content

python package to generate shell-completion for your CLI

Project description

shell-complete-py

python package to generate shell-completion for your CLI

Warning: This project is in the earliest phase possible

Usage

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

from argparse import ArgumentParser
from shell_complete.argparse import ActionGenerate  # note: currently not available

parser = ArgumentParser()
...
parser.add_argument('--completion', action=ActionGenerate,
                    help="Generate a bash-completion-script")

You can also execute the module itself

python3 -m shell_complete [args...]

Or run the console-script

shell-complete [args...]

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

shell-complete-0.0.0.tar.gz (3.1 kB view hashes)

Uploaded Source

Built Distribution

shell_complete-0.0.0-py3-none-any.whl (4.2 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