fastcommand 0.1.7__tar.gz → 0.2.0__tar.gz

{fastcommand-0.1.7 → fastcommand-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: fastcommand
-Version: 0.1.7
+Version: 0.2.0
 Author-email: Jason Morley <hello@jbmorley.co.uk>
 License: MIT License
         
@@ -26,9 +26,13 @@ License: MIT License
         
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: argcomplete
+Dynamic: license-file
 
 # fastcommand
 
+[![build](https://github.com/jbmorley/fastcommand/actions/workflows/build.yaml/badge.svg)](https://github.com/jbmorley/fastcommand/actions/workflows/build.yaml)
+
 Python module for defining multi-command cli programs
 
 ## Description
@@ -37,6 +41,8 @@ The `fastcommand` module is a lightweight wrapper over `argparse` which aims to
 
 ## Usage
 
+### Example
+
 ```python
 import fastcommand
 
@@ -65,3 +71,33 @@ def main():
 if __name__ == "__main__":
     main()
 ```
+
+### Autocomplete
+
+`fastcommand` provides autocomplete using `argcomplete`. Enable it by adding the following the `argcomplete` marker to the to of your application:
+
+```python
+# PYTHON_ARGCOMPLETE_OK
+```
+
+Install `argcomplete` locally to be able to use autocomplete:
+
+```sh
+pip install argcomplete
+```
+
+And then either:
+
+- activate globally by running:
+
+  ```sh
+  activate-global-python-argcomplete
+  ```
+
+- activate it for a specific command by running:
+
+  ```sh
+  eval "$(register-python-argcomplete my-python-app)"
+  ```
+
+See the [`argcomplete` documentation](`argcomplete`](https://pypi.org/project/argcomplete/)) for more details.

{fastcommand-0.1.7 → fastcommand-0.2.0}/README.md

@@ -1,5 +1,7 @@
 # fastcommand
 
+[![build](https://github.com/jbmorley/fastcommand/actions/workflows/build.yaml/badge.svg)](https://github.com/jbmorley/fastcommand/actions/workflows/build.yaml)
+
 Python module for defining multi-command cli programs
 
 ## Description
@@ -8,6 +10,8 @@ The `fastcommand` module is a lightweight wrapper over `argparse` which aims to
 
 ## Usage
 
+### Example
+
 ```python
 import fastcommand
 
@@ -36,3 +40,33 @@ def main():
 if __name__ == "__main__":
     main()
 ```
+
+### Autocomplete
+
+`fastcommand` provides autocomplete using `argcomplete`. Enable it by adding the following the `argcomplete` marker to the to of your application:
+
+```python
+# PYTHON_ARGCOMPLETE_OK
+```
+
+Install `argcomplete` locally to be able to use autocomplete:
+
+```sh
+pip install argcomplete
+```
+
+And then either:
+
+- activate globally by running:
+
+  ```sh
+  activate-global-python-argcomplete
+  ```
+
+- activate it for a specific command by running:
+
+  ```sh
+  eval "$(register-python-argcomplete my-python-app)"
+  ```
+
+See the [`argcomplete` documentation](`argcomplete`](https://pypi.org/project/argcomplete/)) for more details.

{fastcommand-0.1.7 → fastcommand-0.2.0}/fastcommand/main.py

@@ -25,6 +25,8 @@ import functools
 import logging
 import sys
 
+import argcomplete
+
 
 COMMANDS = {}
 
@@ -83,6 +85,7 @@ class CommandParser(object):
                                  help="show verbose output")
 
     def run(self):
+        argcomplete.autocomplete(self.parser)
         options = self.parser.parse_args()
         if 'fn' not in options:
             logging.error("No command specified.")

{fastcommand-0.1.7 → fastcommand-0.2.0}/fastcommand.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: fastcommand
-Version: 0.1.7
+Version: 0.2.0
 Author-email: Jason Morley <hello@jbmorley.co.uk>
 License: MIT License
         
@@ -26,9 +26,13 @@ License: MIT License
         
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: argcomplete
+Dynamic: license-file
 
 # fastcommand
 
+[![build](https://github.com/jbmorley/fastcommand/actions/workflows/build.yaml/badge.svg)](https://github.com/jbmorley/fastcommand/actions/workflows/build.yaml)
+
 Python module for defining multi-command cli programs
 
 ## Description
@@ -37,6 +41,8 @@ The `fastcommand` module is a lightweight wrapper over `argparse` which aims to
 
 ## Usage
 
+### Example
+
 ```python
 import fastcommand
 
@@ -65,3 +71,33 @@ def main():
 if __name__ == "__main__":
     main()
 ```
+
+### Autocomplete
+
+`fastcommand` provides autocomplete using `argcomplete`. Enable it by adding the following the `argcomplete` marker to the to of your application:
+
+```python
+# PYTHON_ARGCOMPLETE_OK
+```
+
+Install `argcomplete` locally to be able to use autocomplete:
+
+```sh
+pip install argcomplete
+```
+
+And then either:
+
+- activate globally by running:
+
+  ```sh
+  activate-global-python-argcomplete
+  ```
+
+- activate it for a specific command by running:
+
+  ```sh
+  eval "$(register-python-argcomplete my-python-app)"
+  ```
+
+See the [`argcomplete` documentation](`argcomplete`](https://pypi.org/project/argcomplete/)) for more details.

{fastcommand-0.1.7 → fastcommand-0.2.0}/fastcommand.egg-info/SOURCES.txt

@@ -7,4 +7,5 @@ fastcommand/main.py
 fastcommand.egg-info/PKG-INFO
 fastcommand.egg-info/SOURCES.txt
 fastcommand.egg-info/dependency_links.txt
+fastcommand.egg-info/requires.txt
 fastcommand.egg-info/top_level.txt

fastcommand-0.2.0/fastcommand.egg-info/requires.txt

@@ -0,0 +1 @@
+argcomplete

{fastcommand-0.1.7 → fastcommand-0.2.0}/pyproject.toml

@@ -9,5 +9,5 @@ license = {file = "LICENSE"}
 authors = [
   {name = "Jason Morley", email = "hello@jbmorley.co.uk"}
 ]
-dependencies = []
+dependencies = ["argcomplete"]
 dynamic = ["version"]