Merge pull request #6 from Descent098/v0.4.0

Merging version 0.4.0 changes

CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## V 0.4.0; February 10th
+
+Focus for this release was breaking up command line parsing into more testable chunks.
+
+Features:
+
+- All argument parsing is now based on discrete functions
+- Added a list command to show your current available commands
+
+Documentation:
+
+- Created API documentation site: https://kieranwood.ca/ahd
+
 ## V 0.3.0; February 6th
 
 Focus for this release was on building sustainable development pipelines (logging, testing etc.), and making the project more reliable in edge cases and error handling.

README.md

@@ -26,21 +26,23 @@ Run ```pip install ahd``` or ```sudo pip3 install ahd```
 ### Usage
 
 ```bash
-Usage: 
-	ahd [-h] [-v] [-d]
+Usage:
+    ahd list [-l]
+    ahd [-h] [-v] [-d]
     ahd docs [-a] [-o]
     ahd config [-e] [-i CONFIG_FILE_PATH]
     ahd register <name> [<command>] [<paths>]
     ahd <name> [<command>] [<paths>]
 
 Options:
-    -h, --help            show this help message and exit
-    -v, --version         show program's version number and exit
-    -a, --api             shows the local API docs
-    -o, --offline         shows the local User docs instead of live ones
-    -e, --export          exports the configuration file
-    -i CONFIG_FILE_PATH, --import CONFIG_FILE_PATH 
-                          imports the configuration file
+-h, --help            show this help message and exit
+-v, --version         show program's version number and exit
+-l, --long            Shows all commands in configuration with paths and commands
+-a, --api             shows the local API docs
+-o, --offline         shows the local User docs instead of live ones
+-e, --export          exports the configuration file
+-i CONFIG_FILE_PATH, --import CONFIG_FILE_PATH
+                    imports the configuration file
 ```
 
 
@@ -60,6 +62,14 @@ This example was somewhat trivial but keep in mind this effectively means you ca
 
 #### Arguments
 
+##### list
+
+The list command shows a list of your current registered commands.
+
+**Options**:
+
+  \- \-\-long: Shows all commands in configuration with paths and commands  
+
 ##### docs
 
 The docs command is designed to bring up documentation as needed, you can run ```ahd docs``` to open the documentation site in the default browser.
@@ -104,7 +114,7 @@ This is a placeholder value for the name of a command you have registered. Once
 
 ## Additional Documentation
 
-Additional user and development/contribution documentation will be available at [https://ahd.readthedocs.io/en/latest/](https://ahd.readthedocs.io/en/latest/).
+Additional user and development/contribution documentation will be available at [https://ahd.readthedocs.io/en/latest/](https://ahd.readthedocs.io/en/latest/). Also API documentation is available at [https://kieranwood.ca/ahd](https://kieranwood.ca/ahd)
 
 
 

ahd/__init__.py

@@ -0,0 +1,6 @@
+"""Top level module for AHD.
+
+Here lies all the code necessary to use AHD as an API.
+
+If you are here to help or contribute to the project, check out the development guide: https://ahd.readthedocs.io/en/latest/contributing/
+"""

ahd/autocomplete.py

@@ -1,4 +1,4 @@
-"""This module is used to generate autocomplete files for vaious systems (bash, zsh etc.)
+"""This module is used to generate autocomplete files for various systems (bash, zsh etc.)
 
 Examples
 --------