Metadata-Version: 2.1
Name: shell-complete
Version: 0.0.0
Summary: python package to generate shell-completion for your CLI
Home-page: https://github.com/utility-libraries/shell-complete-py
Author: PlayerG9
License: MIT
Project-URL: Author Github, https://github.com/PlayerG9
Project-URL: Homepage, https://github.com/utility-libraries/shell-complete-py
Project-URL: Bug Tracker, https://github.com/PlayerG9/shell-complete-py/issues
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Utilities
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# 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`

```python
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

```bash
python3 -m shell_complete [args...]
```

Or run the console-script

```bash
shell-complete [args...]
```
