{"author":null,"author_email":"Casper da Costa-Luis ","bugtrack_url":null,"classifiers":["Development Status :: 5 - Production/Stable","Environment :: Console","Environment :: MacOS X","Environment :: Other Environment","Intended Audience :: Developers","Intended Audience :: Education","Intended Audience :: End Users/Desktop","Intended Audience :: Other Audience","Intended Audience :: System Administrators","License :: OSI Approved :: Apache Software License","Operating System :: MacOS","Operating System :: MacOS :: MacOS X","Operating System :: POSIX","Operating System :: POSIX :: BSD","Operating System :: POSIX :: BSD :: FreeBSD","Operating System :: POSIX :: Linux","Operating System :: POSIX :: SunOS/Solaris","Operating System :: Unix","Programming Language :: Other Scripting Engines","Programming Language :: Python","Programming Language :: Python :: 3","Programming Language :: Python :: 3 :: Only","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.7","Programming Language :: Python :: 3.8","Programming Language :: Python :: 3.9","Programming Language :: Python :: Implementation","Programming Language :: Python :: Implementation :: IronPython","Programming Language :: Python :: Implementation :: PyPy","Programming Language :: Unix Shell","Topic :: Desktop Environment","Topic :: Education :: Computer Aided Instruction (CAI)","Topic :: Education :: Testing","Topic :: Office/Business","Topic :: Other/Nonlisted Topic","Topic :: Software Development","Topic :: Software Development :: Build Tools","Topic :: Software Development :: Libraries","Topic :: Software Development :: Libraries :: Python Modules","Topic :: Software Development :: Pre-processors","Topic :: Software Development :: User Interfaces","Topic :: System","Topic :: System :: Installation/Setup","Topic :: System :: Shells","Topic :: System :: System Shells","Topic :: Terminals","Topic :: Utilities"],"description":"|Logo|\n\nshtab\n=====\n\n|PyPI-Downloads| |Tests| |Coverage| |PyPI| |Conda|\n\n- What: Automatically generate shell tab completion scripts for Python CLI apps\n- Why: Speed & correctness. Alternatives like\n `argcomplete `_ and\n `pyzshcomplete `_ are slow and have\n side-effects\n- How: ``shtab`` processes an ``argparse.ArgumentParser`` object to generate a\n tab completion script for your shell\n\nFeatures\n--------\n\n- Outputs tab completion scripts for\n\n - ``bash``\n - ``zsh``\n - ``tcsh``\n\n- Supports\n\n - `argparse `_\n - `docopt `_ (via `argopt `_)\n\n- Supports arguments, options and subparsers\n- Supports choices (e.g. ``--say={hello,goodbye}``)\n- Supports file and directory path completion\n- Supports custom path completion (e.g. ``--file={*.txt}``)\n\n------------------------------------------\n\n.. contents:: Table of Contents\n :backlinks: top\n\nInstallation\n------------\n\nChoose one of:\n\n- ``pip install shtab``, or\n- ``conda install -c conda-forge shtab``\n\nSee `operating system-specific instructions in the docs `_.\n\nUsage\n-----\n\nThere are two ways of using ``shtab``:\n\n- `CLI Usage `_: ``shtab``'s own CLI interface for external applications\n\n - may not require any code modifications whatsoever\n - end-users execute ``shtab your_cli_app.your_parser_object``\n\n- `Library Usage `_: as a library integrated into your CLI application\n\n - adds a couple of lines to your application\n - argument mode: end-users execute ``your_cli_app --print-completion {bash,zsh,tcsh}``\n - subparser mode: end-users execute ``your_cli_app completion {bash,zsh,tcsh}``\n\nExamples\n--------\n\nSee `the docs for usage examples `_.\n\nFAQs\n----\n\nNot working? Check out `frequently asked questions `_.\n\nAlternatives\n------------\n\n- `argcomplete `_\n\n - executes the underlying script *every* time ```` is pressed (slow and\n has side-effects)\n\n- `pyzshcomplete `_\n\n - executes the underlying script *every* time ```` is pressed (slow and\n has side-effects)\n - only provides ``zsh`` completion\n\n- `click `_\n\n - different framework completely replacing the builtin ``argparse``\n - solves multiple problems (rather than POSIX-style \"do one thing well\")\n\nContributions\n-------------\n\nPlease do open `issues `_ & `pull requests `_! Some ideas:\n\n- support ``fish`` (`#174 `_)\n- support ``powershell``\n\nSee\n`CONTRIBUTING.md `_\nfor more guidance.\n\n|Hits|\n\n.. |Logo| image:: https://github.com/iterative/shtab/raw/main/meta/logo.png\n.. |Tests| image:: https://img.shields.io/github/actions/workflow/status/iterative/shtab/test.yml?logo=github&label=tests\n :target: https://github.com/iterative/shtab/actions\n :alt: Tests\n.. |Coverage| image:: https://codecov.io/gh/iterative/shtab/branch/main/graph/badge.svg\n :target: https://codecov.io/gh/iterative/shtab\n :alt: Coverage\n.. |Conda| image:: https://img.shields.io/conda/v/conda-forge/shtab.svg?label=conda&logo=conda-forge\n :target: https://anaconda.org/conda-forge/shtab\n :alt: conda-forge\n.. |PyPI| image:: https://img.shields.io/pypi/v/shtab.svg?label=pip&logo=PyPI&logoColor=white\n :target: https://pypi.org/project/shtab\n :alt: PyPI\n.. |PyPI-Downloads| image:: https://img.shields.io/pypi/dm/shtab.svg?label=pypi%20downloads&logo=PyPI&logoColor=white\n :target: https://pepy.tech/project/shtab\n :alt: Downloads\n.. |Hits| image:: https://cgi.cdcl.ml/hits?q=shtab&style=social&r=https://github.com/iterative/shtab&a=hidden\n :target: https://cgi.cdcl.ml/hits?q=shtab&a=plot&r=https://github.com/iterative/shtab&style=social\n :alt: Hits\n","description_content_type":"text/x-rst","docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":["License-File"],"home_page":null,"keywords":"tab, complete, completion, shell, bash, zsh, argparse","license":"Apache-2.0","license_expression":null,"license_files":["LICENCE"],"maintainer":null,"maintainer_email":"Iterative ","name":"shtab","package_url":"https://pypi.org/project/shtab/","platform":null,"project_url":"https://pypi.org/project/shtab/","project_urls":{"changelog":"https://github.com/iterative/shtab/releases","documentation":"https://docs.iterative.ai/shtab","repository":"https://github.com/iterative/shtab"},"provides_extra":["dev"],"release_url":"https://pypi.org/project/shtab/1.7.2/","requires_dist":["pytest>=6; extra == \"dev\"","pytest-cov; extra == \"dev\"","pytest-timeout; extra == \"dev\""],"requires_python":">=3.7","summary":"Automagic shell tab completion for Python CLI applications","version":"1.7.2","yanked":false,"yanked_reason":null}

Dependencies of shtab (3).
Dependency	Optional
pytest	true
pytest-cov	true
pytest-timeout	true

Package search

shtab

project_urls

Dependencies

All package metadata

Releases