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

https://travis-ci.org/TylerTemp/docpie.svg?branch=master

ChangeLog

version 0.4.0:

  • [fix] #10, #11 short help(-h) print full doc

  • [new] breaking change. PEP-257 help message supported. add helpstyle for people how need to print raw docsting as help message (the old way)

    that means, when there is extra returning line, extra indent, they will be trimly. This feature makes docpie work as most python doc tool.

    This is very useful when your doc needs to be written as:

    class Test(object):
    
        def some_fun(self):
            """
            Usage: prog hello
            """

    and also in this way:

    docpie.docpie("\n \n Usage: prog [-h]\n\n\n", ["prog", "-h"])
    # will give `Usage: prog [-h]\n` instead of `\n \n Usage: prog [-h]\n\n\n\n`

    supported value for helpstyle: "python" (default), "dedent", "raw"

full changelog & TODOs

Summary

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:
  cp.py [options] <source_file> <target_file>
  cp.py [options] <source_file>... <target_directory> <log_file>

Options:
  -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__)
print(args)

Now run it

$ python cp.py 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 >>

Installation

Install release version:

pip install docpie

Install nightly/dev version:

pip install git+https://github.com/TylerTemp/docpie.git@dev

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 setup.py 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.

Reference

the code in bashlog.py is taken from tornado, and tracemore.py is from python Cookbook

Many examples & tests are from docopt.

License

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.

Source Distribution

docpie-0.4.0.tar.gz (62.5 kB view hashes)

Uploaded Source

Built Distribution

docpie-0.4.0-py2.py3-none-any.whl (71.3 kB view hashes)

Uploaded Python 2 Python 3

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