Skip to main content

An easy and Pythonic way to create your POSIX command line interface

Project description

An easy and Pythonic way to create your POSIX command line

View on: GitHub / PyPi


version 0.4.1:

  • [fix] #11 error handler. Now docpie will print an extra n when error occurs, and leave two linebreakers between usage and option section

     SCRIPT [options]
     -h, --help   show help
    import docpie
    arguments = docpie.docpie(__doc__, argv=['prog', '--no-such'])
    # // now
    # Unknown option: --no-such.
    # Usage:
    #  SCRIPT [options]
    # // always has one linebreaker here
    # Options:
    #  -h, --help   show help
    # // only one linebreaker, as many programs do
    # // before
    # Unknown option: --no-such.
    # Usage:
    #  SCRIPT [options]
    # Options:  // missing linebreaker
    #  -h, --help   show help
    # // more than one linebreakers

full changelog & TODOs


How do you define your command line interface? Write a parse by yourself or spend hours learning optparse / argparse , and modify both code side and document every time you update the interface?

Life is short, man! You can simply do it this way:

My copy script

Usage: [options] <source_file> <target_file> [options] <source_file>... <target_directory> <log_file>

  -h -? --help    print this screen
  --version       print the version of this script
  -v --verbose    print more information while  running

from docpie import docpie
args = docpie(__doc__)

Now run it

$ python a.txt b.txt c.txt /tmp cp.log
{'--': False,
 '--help': False,
 '--verbose': False,
 '--version': False,
 '-?': False,
 '-h': False,
 '-v': False,
 '<log_file>': 'cp.log',
 '<source_file>': ['a.txt', 'b.txt', 'c.txt'],
 '<target_directory>': '/tmp',
 '<target_file>': None}

Write a __doc__, pass it to a function, DONE! Isn’t it simple?

try it >>


Install release version:

pip install docpie

Install nightly/dev version:

pip install git+

docpie has been tested with Python:

  • 2.6, 2.7, pypy-2.0, pypy-2.6
  • 3.2, 3.3, 3.4, 3.5, pypy3-2.4

You can run test suit by python test

Get Start!

Interested? Visit Wiki and get start!

Or you can try it in your browser

Why docpie?

docpie can greatly reduce the work you need to be done for command-line interface. What you see is what you get. Every time you only need to update your document, and keep the code unchanged.

See here for more reasons.


the code in is taken from tornado, and is from python Cookbook

Many examples & tests are from docopt.


docpie is released under MIT-License

Project details

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
docpie-0.4.1-py2.py3-none-any.whl (71.1 kB) Copy SHA256 hash SHA256 Wheel 3.6
docpie-0.4.1.tar.gz (62.7 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page