ec 0.1.2

ec - a simpler, yet better implementation of Commander, a module launcher.

ec

ec - a simpler, yet better implementation of Commander, a module launcher.

• Free software: MIT license

  Note: The docs serve as a reference, as well as act as a design guide throught the alpha version. Hence incase of an inconsistency, assume it as a work in progress.

Features

• Shell and Dispatch modes.

• Typed args.

• Every arg is to be input, separately; with every query having a description, default value etc.

History

v0.1.2 (2015-07-06)

Log

• 20150623

  • 1739 Scaffolded from the template laufire-py-package, v0.1.0.

  • 2355 Preparation done.

• 20150625

  • 1000 Decided to use a single dictionary arg as the way to provide data to the functions, over using multiple args (the common python way), as the former is more elegant. And also because kwargs aren’t available on other platforms, thus making the implementation of the API, hard.

  • 1745 The development of the library is suspended, as the intended improvements over commander are added to commander itself.

• 20150629

  • 1440 Resumed the development.

  • 1740 Dispatch mode completed.

  • 2200 Shell mode completed.

  • 2200 It tool ~7hrs to implement a working prototype, most of the time went to developing the details.

  • 2300 Added scripts/examples/nut_shell.py.

  • 2305 Added scripts/tests/config.py.

• 20150630

  • 0105 Found that sphinx-autodoc cannot document objects of custom classes.

  • 0135 Generated some primitive documentation for nut_shell.py using autodoc.

  • 1640 Made ec embeddable.

  • 1820 Made ec completely embeddable.

  • 1820 Documented nut_shell.py using sphinx autodoc.

  • 1900 Class based groups could now have ec members.

  • 1915 Redid the entry points. ec could now be used to launch scripts.

  • 2005 ec could now be used to launch all the scripts in a dir.

  • 2050 Linted the scripts.

• 20150701

  • 0100 Extracted the workers from the decorators in config.py. It is done in order to avoid re-parsing the workers over and over.

  • 0330 Added a custom type types.regex.pattern. It took ~20 mins.

  • 0515 Unknown args are now filtered out.

  • 0520 Added a custom type lib types.multi, that helps with inputs related to lists.

  • 2100 Class, CustomType introduced.

  • 2130 Changed input string generation process of the variables.

  • 2240 Added ec.call, that allow the calling of tasks with partial inputs.

  • 2315 Added a custom type types.basics.yn.

• 20150702

  • 0055 Added a custom type types.adv.t2t, which could convert ec args into custom types.

  • 0140 Dispatch mode now supports flags.

  • 0145 Dispatch mode flag -p introduced to allow sending partial args to the executing command.

  • 0345 ec scripts could now be wrapped (by other modules to provide extended functionality, like a GUI etc).

  • 0520 Added interface.py to help with wrapping ec.

  • 0550 helper_tasks.py introduced.

  • 0750 Wrote some tests.

  • 1405 Added TODO.rst.

  • 1535 Added toolsspellcheckbat.

  • 1620 Added toolsdist.bat.

  • 1655 Pushed to github.

  • 1735 Registerd the package at PiPy.

  • 2145 Shell mode now supports None inputs, through the 0 (^z) char.

  • 2005 Command routes are now separated by ‘/’, instead of ‘ ‘; in order to closely emulate query strings.

  • 2005 Dispatch mode now None inputs, through omitted ‘=’ signs after the arg names. ie: in task1 a b=1, the value of a will be None.

• 20150702

  • 1830 Tuned config processing to be cleaner.

  • 1925 Aliases introduced.

  • 1935 docsdev_notes.rst added.

• 20150702

  • 1310 Introduced ec.utils, with a set of utility functions for the scripts.

  • 1340 Introduced ec.utils.get, that helps to interactively get user input.

  • 1355 Renamed the module, ec.ec to ec.config.

  • 1645 Tuned the handling of description strings.

  • 1705 Bug fixed: -h flag in the dispatch mode wasn’t working.

• 20150705

  • 2145 Renamed the module, ec.config back to ec.ec, as it felt more apt .

  • 2310 Added __info__.py.

• 20150706

  • 0045 Added types.multi.menu.

  • 0255 Bug fixed: dist builds weren’t including some needed modules.