Turn functions into command-line interfaces
Project description
Clize is an argument parser for Python. You can use Clize as an alternative to argparse if you want an even easier way to create command-line interfaces.
With Clize, you can:
Create command-line interfaces by creating functions and passing them to clize.run.
Enjoy a CLI automatically created from your functions’ parameters.
Bring your users familiar --help messages generated from your docstrings.
Reuse functionality across multiple commands using decorators.
Extend Clize with new parameter behavior.
Here’s an example:
from clize import run
def hello_world(name=None, *, no_capitalize=False):
"""Greets the world or the given name.
:param name: If specified, only greet this person.
:param no_capitalize: Don't capitalize the given name.
"""
if name:
if not no_capitalize:
name = name.title()
return 'Hello {0}!'.format(name)
return 'Hello world!'
if __name__ == '__main__':
run(hello_world)
The python code above can now be used on the command-line as follows:
$ pip install clize
$ python3 hello.py --help
Usage: hello.py [OPTIONS] name
Greets the world or the given name.
Positional arguments:
name If specified, only greet this person.
Options:
--no-capitalize Don't capitalize the given name.
Other actions:
-h, --help Show the help
$ python3 hello.py
Hello world!
$ python3 hello.py john
Hello John!
$ python3 hello.py dave --no-capitalize
Hello dave!
You can find the documentation and tutorials at http://clize.readthedocs.io/
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for clize-5.0.0b1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7008a344b91fb941e9f40ed35ce393b96264e0dac8fb1beae47afcdb6ace3c4c |
|
MD5 | 31ebcf2fa8cbdc7e1cd4760d6c1e3da6 |
|
BLAKE2b-256 | f66e4a6f02c6baf336cc29b6e8cadc76c518393299f7964ed63faf3eab900b67 |