Skip to main content

A python module to help create predictable command line tools for python >= 2.6 and 3.x

Project description

A python module to help create predictable command line tools for python >= 2.6 and 3.x

pycli_tools is a python module that wraps the ArgumentParser class from the build-in argparse module.

If you use it in your command line scripts you will get some defaults options added to your application such as –verbose and –quiet to control the verbosity of your application (using the python logging module).

Also there is the –config option that gives you the ability to read command line arguments from a configuration file to save users of your application a lot of typing (e.g. ~/.myapprc).

Copyright (c) 2013 Nico Di Rocco.
License: MIT (see LICENSE for details).

installation

The easiest way is to install using pip:

$ pip install pycli_tools

Read the documentation for alternative ways of installing.

usage

To create a myapp command that reads its default configuration from ~/.myapprc do this:

from pycli_tools.parsers import get_argparser

parser = get_argparser(prog='myapp', default_config='~/.myapprc')
parser.add_argument('--database')
parser.add_argument('file')
args = parser.parse_args()

The file ~/.myapprc can contain the following:

[myapp]
database = /some/path/to/my/database.sqlite

Read the documentation to see how to use pycli_tools.

documentation

Read the full documentation here.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pycli_tools-2.0.2.tar.gz (7.0 kB view details)

Uploaded Source

File details

Details for the file pycli_tools-2.0.2.tar.gz.

File metadata

  • Download URL: pycli_tools-2.0.2.tar.gz
  • Upload date:
  • Size: 7.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for pycli_tools-2.0.2.tar.gz
Algorithm Hash digest
SHA256 6ffafa63d24969510b16d5861ea01572b06de2531751f9b59237054c7c8b3e5b
MD5 fb73cadb0e25e681daa5abab2fd5eaf9
BLAKE2b-256 78ef9a4133c6625d844f53fa7a9a2945a800dd1eebc551831f0b90373bae555b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page