The full version of this documentaion is at clime.mosky.tw.
Clime
Clime lets you convert any module into a multi-command CLI program with zero configuration.
The main features:
It works well with zero configuration. Free you from the configuration hell.
Docstring (i.e., help text) is just configuration. When you finish your docstring, the configuration of aliases and metavars is also finished.
It generates usage for each command automatically.
It is a better choice than the heavy optparse or argparse for most of the CLI tasks.
CLI-ize ME!
Let me show you Clime with an example.
We have a simple script with a docstring here:
# file: repeat.py
def repeat(message, times=2, count=False):
'''It repeats the message.
options:
-m=<str>, --message=<str> The description of this option.
-t=<int>, --times=<int>
-c, --count
'''
s = message * times
return len(s) if count else s
After we add this line:
import clime.now
Our CLI program is ready!
$ python repeat.py twice twicetwice $ python repeat.py --times=3 thrice thricethricethrice
It also generates a pretty usage for this script:
$ python repeat.py --help usage: [-t <int> | --times=<int>] [-c | --count] <message> or: repeat [-t <int> | --times=<int>] [-c | --count] <message>
If you have a docstring in your function, it also shows up in usage manual with --help.
$ python repeat.py repeat --help
usage: [-t <int> | --times=<int>] [-c | --count] <message>
or: repeat [-t <int> | --times=<int>] [-c | --count] <message>
It repeats the message.
options:
-m=<str>, --message=<str> The message.
-t=<int>, --times=<int>
-c, --count
You can find more examples in the clime/examples.
Command describes more about how it works.
Installation
Clime is hosted on two different platforms, PyPI and GitHub.
Install from PyPI
Install Clime from PyPI for a stable version:
$ sudo pip install clime
If you don’t have pip, execute
$ sudo apt-get install python-pip
to install pip on Debian-base Linux distribution.
Get Clime from GitHub
If you want to follow the latest version of Clime, use
$ git clone git://github.com/moskytw/clime.git
to clone a Clime repository, or download manually from GitHub.
1 maintainer
Metadata
1 maintainer
Release files for clime 0.3.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| clime-0.3.1.tar.gz | 20.4 kB | Details |
Release files / clime-0.3.1.tar.gz
| Download URL | clime-0.3.1.tar.gz |
|---|---|
| Size | 20.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d64ce5bbef27534dc2f88b8154c903b9e416cd0c294bb3aa74fecd826f42c37c
|
|
BLAKE2b-256 checksum How to use checksums |
162c9ec5c1093aba7501bc927dd287e3751a1b641eba262df3b192052e0c5672
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
