Python utility for writing command line scripts with consistent look and feel.
Project description
cmdhelper is a Python utility for writing command line scripts with a consistent style, default set of command line options, and common approach to logging.
cmdhelper provides:
Parsing of command line options using either argparse or optparse.
Setup of logging with the possibility to copy stdout or stderr into the logfile.
Possibility to e-mail log messages upon completion with an option to send the e-mail only if a log message with a severity at or above a trigger level was recorded.
Definition of a set of default options, including options to set verbosity and logging options.
A utility function to run external commands whose output can be logged and parsed for error messages.
A utility function for asking the user to confirm actions.
Example
A script that processes different commands with optional command arguments might include:
from cmdhelper import * cmdHelper = CmdHelper('argparse', __version__) cmdHelper.add_argument('cmd', help='command') cmdHelper.add_argument('args', help='command arguments', nargs='*') cmdHelper.add_option('-x', '--example', dest='value', default=None, help='sample option') options = cmdHelper.parse() try: # processing goes here pass except Exception as e: handleError(e,options.debug)
Running the above code with –help will produce the following output:
usage: example.py [-h] [--version] [-i] [-v] [--debug] [--noscreen] [--logfile LOGFILE] [--loglevel LOGLEVEL] [--logseparator LOGSEPARATOR] [--logtimestampfmt LOGTIMESTAMPFMT] [--emailto EMAILTO] [--emailsubject EMAILSUBJECT] [--emaillevel EMAILLEVEL] [--emailtriglevel EMAILTRIGLEVEL] [-x VALUE] cmd [args [args ...]] positional arguments: cmd command args command arguments optional arguments: -h, --help show this help message and exit --version show program's version number and exit -i, --interactive enter interactive Python at completion -v, --verbose verbose output --debug debugging output --noscreen disable logging output to screen --logfile LOGFILE write logging information to this file (default: ) --loglevel LOGLEVEL logging level for logfile (default: INFO or DEBUG) --logseparator LOGSEPARATOR message to write to logfile at beginning of new log --logtimestampfmt LOGTIMESTAMPFMT timestamp format string (in logging formatter format) --emailto EMAILTO email address receiving any log messages --emailsubject EMAILSUBJECT subject for log e-mails --emaillevel EMAILLEVEL logging level for e-mails (default: WARNING) --emailtriglevel EMAILTRIGLEVEL trigger level for sending e-mails (default: None) -x VALUE, --example VALUE sample option
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
File details
Details for the file cmdhelper-0.3.1.tar.gz
.
File metadata
- Download URL: cmdhelper-0.3.1.tar.gz
- Upload date:
- Size: 12.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: Python-urllib/2.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
db753cbbf3a03de2c04b0aa284db8dd59c5dba8c78cabab9579ee1fc42bca1da
|
|
MD5 |
4264c5e37d1acaae8ea989ad1b0dde70
|
|
BLAKE2b-256 |
8dc21269039a36bc1eccee8a0a2a858736aa8044558fecc1cba7a7d08458c410
|