Python argparse skeleton
Python
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
cli fix argv Feb 1, 2017
tests Fix test utilities import Feb 1, 2017
.coveragerc add unrunnable code Feb 1, 2017
.gitignore Initial commit Apr 5, 2016
.travis.yml add 3.6 Feb 1, 2017
LICENSE Initial commit Apr 5, 2016
README.md Update readme Feb 1, 2017
requirements.txt add clint requirement Feb 1, 2017
setup.py cleanup tests Feb 1, 2017

README.md

Build Status Coverage Status

python-cli-skeleton

A simple python command line interface skeleton project. Features support for:

  • travis-ci
  • coveralls
  • argparse
  • py.test (testing)

Installation

python setup.py install 

For development, use:

python setup.py develop

...and the program will be installed in-place, allowing you to edit the script files and test them from the command line.

Usage

The setup script will install the program as cli. You can invoke it using:

cli

To change the way the program is invoked, edit the cli/__init__.py file where you can set the __version__ and _program variables. The _program variable sets the commandline command (cli), and the program name. You may want to change the names of modules (folders) as well to reflect your program. You should change the entry_point part of the setup script to reflect any changes you make to folders/files:

entry_points="""
[console_scripts]
{program} = cli.cli:main
""".format(program = _program),

requirements.txt

Add any modules you want installed to the requirements.txt file. The setup file parses this file before installation. Currently, [clint](https://github.com/kennethreitz/clint) is the only requirement. It is a useful module for adding color, indenting, progress bars, and other useful things to command-line based programs.

travis-ci

A .travis.yml file is included and setup for Python. Testing is performed using Python 2.7 and 3.6. You will need to setup [travis-ci.org](travis-ci.org) to perform testing.

coveralls

Support for coveralls is build in using pytest-cov. Please see coveralls.io for more information. You may want to edit the .coveragerc file to fine tune how coverage is calculated.