Merge branch 'master' of github.com:nicfit/nicfit.py

* 'master' of github.com:nicfit/nicfit.py:
  Some docs, and example commands.

Author: nicfit

Makefile

@@ -90,6 +90,10 @@ test: gettext
 	pytest $(_PYTEST_OPTS) $(_PDB_OPTS) ${TEST_DIR}
 
 test-all:
+	for example in `ls ./examples/*.py`; do \
+		echo "Runninig $$example..."; \
+		./$$example > /dev/null ; \
+	done
 	tox
 
 coverage: gettext

README.rst

@@ -2,7 +2,7 @@
 nicfit.py README
 =================
 
-Common Python utils (App, logging, config, etc.)
+Basic building blocks for building Python applications.
 
 Status
 ------
@@ -28,4 +28,11 @@ Status
 Features
 --------
 
+* Common appplication skeletons (including async) providing common argument
+  parsing add-ons and utilities, error handling boiler-plate, and application
+  life-cycle hooks. Including intregrated `cookiecutter` that
+  suuports updating to future versions with auto-merging.
+* Simple command API based on :mod:`argparse` and sub-parsers.
+* Integrated configuation file (based on configparser) utitiles.
+* Logging extras (e.g. verbose level) and command line configuration.
 * Free software: MIT license

cookiecutter/{{cookiecutter.project_name}}/.gitignore

@@ -1,4 +1,4 @@
-.idea
+.idea/
 .cookiecutter.md5
 _misc/
 

examples/asyncio_example.py

@@ -1,11 +1,13 @@
-import nicfit
+#!/usr/bin/env python
+import time
 from nicfit.aio import Application
 
 async def _main(args):
-    import time
     print(args)
-    time.sleep(5)
-    return 5
+    print("Sleeping 2...")
+    time.sleep(2)
+    print("Sleeping 0...")
+    return 0
 
 def atexit():
     print("atexit")

examples/commands.py

@@ -0,0 +1,55 @@
+#!/usr/bin/env python
+import nicfit
+
+@nicfit.Command.register
+class Hi(nicfit.Command):
+    NAME = "hi"
+    ALIAS = ["hello"]
+    HELP = "A simple hello command."
+    DESC = "This command can speak Spanish a command line option."
+
+    def _initArgParser(self, parser):
+        parser.add_argument("--spanish", action="store_true",
+                            help="Respond in Spanish")
+
+    def _run(self):
+        print("Hola" if self.args.spanish else "Hi")
+
+@nicfit.Command.register
+class bye(nicfit.Command):
+    HELP = "A simple hello command."
+    def _run(self):
+        print("Bye")
+
+# Until Python 3.7 ArgumentParser.add_subparsers does not support the `required`
+# keyword, nicfit.ArgumentParser handles this.
+parser = nicfit.ArgumentParser()
+nicfit.Command.loadCommandMap(parser.add_subparsers(dest="cmd", required=True))
+args = parser.parse_args()
+args.command_func(args)
+
+"""
+$ ./cmds2.py 
+usage: cmds2.py [-h] {bye,hi} ...
+cmds2.py: error: the following arguments are required: cmd
+$ ./cmds2.py --help
+usage: cmds2.py [-h] {hi,bye} ...
+
+positional arguments:
+  {hi,bye}
+    hi        A simple hello command.
+    bye       A simple hello command.
+
+optional arguments:
+  -h, --help  show this help message and exit
+$ ./cmds2.py hi --help
+usage: cmds2.py hi [-h] [--spanish]
+
+This command can speak Spanish a command line option.
+
+optional arguments:
+  -h, --help  show this help message and exit
+  --spanish   Respond in Spanish
+$ ./cmds2.py hi --spanish
+Hola
+"""

examples/curio_example.py

@@ -1,11 +1,11 @@
-import nicfit
+#!/usr/bin/env python
+import time
 from nicfit.curio import Application
 
 async def _main(args):
-    import time
     print(args)
-    time.sleep(5)
-    return 5
+    time.sleep(2)
+    return 0
 
 def atexit():
     print("atexit")

examples/example.py

@@ -1,23 +1,25 @@
+#!/usr/bin/env python
 import time
 import nicfit
 
 def main(args):
-    print(args)
+    print("Parsed command line args:", args)
     try:
-        time.sleep(15)
+        print("Sleeping 5, Ctrl-C to interupt...")
+        time.sleep(10)
     except KeyboardInterrupt:
-        raise ValueError()
-        return 1
+        print("Returning 2...")
+        return 2
     else:
+        print("Returning 0...")
         return 0
 
 def atexit():
-    print("in case you care")
+    print("atexit, in case you care")
 
 
 app = nicfit.Application(main, name="example", description="Just an example",
-                         version="1.0.0-alpha",
-                         atexit=atexit, pdb_opt=True)
+                         version="1.0a0", atexit=atexit, pdb_opt=True)
 app.arg_parser.add_argument("--example", help="Example cli")
 app.run()
 assert not"will not execute"

nicfit/_argparse.py

@@ -1,5 +1,7 @@
 import sys
 import argparse
+import gettext
+_ = gettext.gettext
 
 
 class ArgumentParser(argparse.ArgumentParser):