Version 1.0 release

innot · Jun 19, 2022 · ced6b25 · ced6b25
1 parent 6708d7b
commit ced6b25
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -36,7 +36,7 @@ cmdline = input()
 cli.execute(cmdline)
 ```
 
-The ArgParseDecorator uses both the signature of the decorated function as well as its
+The ArgParseDecorator uses both the signature of the decorated function and its
 [docstring](https://peps.python.org/pep-0257/) to infer information, metadata and description of the function arguments
 and passes them to the underlying ArgumentParser.
 
@@ -89,7 +89,7 @@ Now a command line can be parsed and executed like this:
    result = cli.execute("ls -a -c 2 --sort rev --ignore *.log")
 ```
 
-ArgParseDecorator uses the docstring of the decorated function to get a help string for the command and it also parses
+ArgParseDecorator uses the docstring of the decorated function to get a help string for the command, and it also parses
 [Sphinx](https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html) style directives to provide help strings
 for arguments as well as additional metadata that can not be written as annotations.
 

diff --git a/docs/source/intro.rst b/docs/source/intro.rst
@@ -97,7 +97,7 @@ information
     optional arguments:
       --squared, -sq  when present square each number first
 
-See :doc:'docstring' for more details and examples.
+See :ref:`Using the argparseDecorator` for more details and examples.
 
 
 .. _argparse: https://docs.python.org/3/library/argparse.html

diff --git a/docs/source/usage.rst b/docs/source/usage.rst
@@ -4,8 +4,13 @@ Using the argparseDecorator
 Install
 -------
 
-.. note::
-    argparseDecorator has not yet been uploaded to Pypi. Install by downloading from github instead.
+The easiest way to install argparseDecorator is with pip:
+
+.. code-block::
+
+    $ pip import argparseDecorator
+
+Alternativly the sources can be downloaded directly from the `Github <https://github.com/innot/argparseDecorator>` page.
 
 
 Once argparseDecorator has been installed it can be used like this.

diff --git a/setup.cfg b/setup.cfg
@@ -1,6 +1,6 @@
 [metadata]
 name = ArgParseDecorator
-version = 1.0.0rc1
+version = 1.0.1
 author = Thomas Holland
 author_email = thomas@innot.de
 description = A tool to easily build command line interpreters
@@ -28,7 +28,7 @@ classifiers =
 packages = find:
 
 [options.packages.find]
-include=argparsedecorator*
-exclude=test*
+include=argparsedecorator
+exclude=test/*