Automatically make a command line interface from a class or function.
Project description
optmagic
version 1.0.2
This project enables you to create simple command line interfaces starting with a class, or a function that you want to expose directly to the shell.
It contains functionality which has not yet all been fully documented.
Similar projects
Why not use one of those?
The programmer should not have to specify anything extra than what the class or function already contains to expose its functionality.
Demo
TODO
Installing
To install the optmagic
package, simply type the following commands on your terminal:
$ pip3 install optmagic
Dependencies
The projects depends on the following module for parsing docstrings:
docstring_parser
If you want to run the test suite for optmagic
you need the following extra libraries:
pytest
matplotlib
pbs3
Extra documentation
More documentation is available at:
http://xapple.github.io/optmagic/optmagic
This documentation is simply generated with:
$ pdoc3 --html --output-dir docs --force optmagic
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.