You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Charles Reid c0466ab6c6 Merge branch 'master' of 5 years ago
cli in case of fire: git commit, git push, exit the building 5 years ago
tests in case of fire: git commit, git push, exit the building 5 years ago
.coveragerc add unrunnable code 6 years ago
.gitignore add pytest cache to .gitignore 5 years ago
.travis.yml add 3.6 6 years ago
LICENSE Initial commit 7 years ago Update '' 5 years ago
requirements.txt add clint requirement 6 years ago add static data to package, add (no command) and (ls command) workflows 5 years ago


Build Status Coverage Status


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

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


python install 

For development, use:

python develop

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


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


To change the way the program is invoked, edit the cli/ 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:

{program} = cli.cli:main
""".format(program = _program),


Add any modules you want installed to the requirements.txt file. The setup file parses this file before installation. Currently, [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.


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 []( to perform testing.


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