Merge pull request #215 from neithere/release/v0.31.1

Release v0.31.1

.github/ISSUE_TEMPLATE/bug_report.md

@@ -11,14 +11,14 @@ assignees: neithere
 A clear and concise description of what the bug is.
 
 ### To Reproduce
-Example script:
-```
+Python script:
+```python
 import argh
 
 SOME CODE
 ```
 
-Example command line interaction:
+Command line input/output:
 ```
 $ my-script.py ...
 SOME OUTPUT

.readthedocs.yml

@@ -13,7 +13,7 @@ build:
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
-  configuration: docs/source/conf.py
+  configuration: docs/conf.py
 
 # NOTE: PDF generation was intentionally disabled due to failed builds.
 # Should you require enabling this, please make sure that it's tested.

CHANGES.rst → CHANGELOG.rst

@@ -1,6 +1,17 @@
 Changelog
 =========
 
+Version 0.31.1 (2024-01-19)
+---------------------------
+
+Bugs fixed:
+
+- broken support for type alias `List` (issue #216).
+
+Enhancements:
+
+- cleaned up the README, rearranged other documentation.
+
 Version 0.31.0 (2023-12-30)
 ---------------------------
 

README.rst

@@ -1,5 +1,5 @@
-Argh: The Natural CLI
-=====================
+Argh: The Effortless CLI
+========================
 
 .. image:: https://github.com/neithere/argh/actions/workflows/lint-and-test.yml/badge.svg
     :target: https://github.com/neithere/argh/actions/workflows/lint-and-test.yml
@@ -25,21 +25,71 @@ Argh: The Natural CLI
 .. image:: https://readthedocs.org/projects/argh/badge/?version=latest
     :target: http://argh.readthedocs.org/en/latest/
 
+**The power of Argparse with plain Python functions!**
+
 Building a command-line interface?  Found yourself uttering "argh!" while
 struggling with the API of `argparse`?  Don't like the complexity but need
 the power?
 
-.. epigraph::
+`Argh` builds on the power of `argparse` (which comes with Python) and makes it
+really easy to use.  It eliminates the complex API and lets you "dispatch"
+ordinary Python functions as CLI commands.
+
+Installation
+------------
 
-    Everything should be made as simple as possible, but no simpler.
+::
 
-    -- Albert Einstein (probably)
+    $ pip install argh
 
-`Argh` is a smart wrapper for `argparse`.  `Argparse` is a very powerful tool;
-`Argh` just makes it easy to use.
+Example
+-------
 
-In a nutshell
--------------
+.. code-block:: python
+
+    import argh
+
+    def verify_paths(paths: list[str], *, verbose: bool = False):
+        """
+        Verify that all given paths exist.
+        """
+        for path in paths:
+            if verbose:
+                print(f"Checking {path}...")
+            assert os.path.exists(path)
+
+    argh.dispatch_command(verify_paths)
+
+Now you can run the script like this:
+
+.. code-block:: bash
+
+    $ python app.py foo.txt bar/quux.txt
+
+    $ python app.py foo.txt bar/quux.txt --verbose
+    Checking foo.txt...
+    Checking bar/quux.txt...
+
+    $ python app.py -h
+    usage: app.py [-h] [-v] [paths ...]
+
+    Verify that all given paths exist.
+
+    positional arguments:
+      paths          -
+
+    options:
+      -h, --help     show this help message and exit
+      -v, --verbose  False
+
+Please check the documentation for examples of multiple commands, modularity,
+help generation, advanced type annotations inspection, decorators and more:
+
+* `Quick Start <https://argh.readthedocs.io/en/latest/quickstart.html>`_
+* `Tutorial <https://argh.readthedocs.io/en/latest/tutorial.html>`_
+
+Why Argh?
+---------
 
 `Argh`-powered applications are *simple* but *flexible*:
 
@@ -80,198 +130,33 @@ In a nutshell
 :Compact:
     No dependencies apart from Python's standard library.
 
-Sounds good?  Dive in! :)
-
-* `Quick Start <https://argh.readthedocs.io/en/latest/quickstart.html>`_
-* `Tutorial <https://argh.readthedocs.io/en/latest/tutorial.html>`_
-
-Relation to argparse
---------------------
-
-`Argh` is fully compatible with `argparse`.  You can mix `Argh`-agnostic and
-`Argh`-aware code.  Just keep in mind that the dispatcher does some extra work
-that a custom dispatcher may not do.
-
-Installation
-------------
-
-::
-
-    $ pip install argh
-
-Examples
---------
-
-Hello World
-...........
-
-A very simple application with one command:
-
-.. code-block:: python
-
-    import argh
-
-    def main() -> str:
-        return "Hello world"
-
-    argh.dispatch_command(main)
-
-Run it:
-
-.. code-block:: bash
-
-    $ ./app.py
-    Hello world
-
-Type Annotations
-................
-
-Type annotations are used to infer argument types:
-
-.. code-block:: python
-
-    def summarise(numbers: list[int]) -> int:
-        return sum(numbers)
-
-    argh.dispatch_command(summarise)
-
-Run it (note that ``nargs="+"`` + ``type=int`` were inferred from the
-annotation):
-
-.. code-block:: bash
-
-    $ ./app.py 1 2 3
-    6
-
-Multiple Commands
-.................
-
-An app with multiple commands:
-
-.. code-block:: python
-
-    import argh
-
-    from my_commands import hello, echo
-
-    argh.dispatch_commands([hello, echo])
-
-Run it:
-
-.. code-block:: bash
-
-    $ ./app.py echo Hey
-    Hey
-
-Modularity
-..........
-
-A potentially modular application with more control over the process:
-
-.. code-block:: python
-
-    import argh
-
-    # declaring:
-
-    def echo(text):
-        "Returns given word as is."
-        return text
-
-    def greet(name: str, *, greeting: str = "Hello") -> str:
-        "Greets the user with given name. The greeting is customizable."
-        return f"{greeting}, {name}!"
-
-    # assembling:
-
-    parser = argh.ArghParser()
-    parser.add_commands([echo, greet])
-
-    # dispatching:
-
-    if __name__ == "__main__":
-        parser.dispatch()
-
-.. code-block:: bash
-
-    $ ./app.py greet Andy
-    Hello, Andy
-
-    $ ./app.py greet Andy -g Arrrgh
-    Arrrgh, Andy
-
-Here's the auto-generated help for this application (note how the docstrings
-are reused)::
-
-    $ ./app.py --help
-
-    usage: app.py {echo,greet} ...
-
-    positional arguments:
-        echo        Returns given word as is.
-        greet       Greets the user with given name. The greeting is customizable.
-
-...and for a specific command (an ordinary function signature is converted
-to CLI arguments)::
-
-    $ ./app.py --help greet
-
-    usage: app.py greet [-g GREETING] name
-
-    Greets the user with given name. The greeting is customizable.
-
-    positional arguments:
-      name
-
-    optional arguments:
-      -g GREETING, --greeting GREETING   'Hello'
-
-(The help messages have been simplified a bit for brevity.)
-
-Decorators
-..........
-
-`Argh` easily maps plain Python functions to CLI.  Sometimes this is not
-enough; in these cases the powerful API of `argparse` is also available:
-
-.. code-block:: python
-
-    @arg("words", default="hello world", nargs="+", help="The message")
-    def echo(words: list[str]) -> str:
-        return " ".join(words)
-
-Please note that decorators will soon be fully replaced with annotations.
-
 Links
 -----
 
-* `Project home page`_ (GitHub)
-* `Documentation`_ (Read the Docs)
-* `Package distribution`_ (PyPI)
-* Questions, requests, bug reports, etc.:
-
-  * `Issue tracker`_ (GitHub)
-  * Direct e-mail (neithere at gmail com)
+See also the `project page on GitHub`_, `documentation`_ and `PyPI page`_.
 
-.. _project home page: http://github.com/neithere/argh/
+.. _project page on GitHub: http://github.com/neithere/argh/
 .. _documentation: http://argh.readthedocs.org
-.. _package distribution: http://pypi.python.org/pypi/argh
-.. _issue tracker: http://github.com/neithere/argh/issues/
+.. _PyPI page: http://pypi.python.org/pypi/argh
 
 Author
 ------
 
 Developed by Andrey Mikhaylenko since 2010.
 
-See file `AUTHORS.rst` for a list of contributors to this library.
+See `contributors <https://argh.readthedocs.io/en/latest/contributors.html>`_
+for a list of contributors to this library.
 
-Support
--------
+Contribute
+----------
 
 The fastest way to improve this project is to submit tested and documented
 patches or detailed bug reports.
 
-You can also `donate via Liberapay`_.  This may speed up development or simply
+Donate
+------
+
+You can `donate via Liberapay`_.  This may speed up development or simply
 make the original author happy :)
 
 .. _donate via Liberapay: https://liberapay.com/neithere/donate