Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

doc to argparse driven by docopt

Project Description
argopt
======

doc to argparse driven by docopt

|PyPi Status|
|Build Status| |Coverage Status| |Branch Coverage Status|

Define your command line interface (CLI) from a docstring (rather than the
other way around). Because it's easy. It's quick. Painless. Then focus on
what's actually important - using the arguments in the rest of your program.

The problem is that this is not always flexible. Still need all the features of
`argparse`? Now have the best of both worlds... all the extension such as
`argcomplete <https://github.com/kislyuk/argcomplete>`__ or
`Gooey <https://github.com/chriskiehl/Gooey/>`__ but with the simple syntax of
`docopt <https://github.com/docopt/docopt/>`__.

------------------------------------------

.. contents:: Table of contents
:backlinks: top
:local:


Installation
------------

Latest pypi stable release
~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code:: sh

pip install argopt

Latest development release on github
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Pull and install in the current directory:

.. code:: sh

pip install -e git+https://github.com/casperdcl/argopt.git@master#egg=argopt


Changelog
---------

The list of all changes is available either on
`Github's Releases <https://github.com/casperdcl/argopt/releases>`__
or on crawlers such as
`allmychanges.com <https://allmychanges.com/p/python/argopt/>`__.


Usage
-----

Standard `docopt <https://github.com/docopt/docopt>`__ docstring syntax applies.
Additionally, some improvements and enhancements are supported, such as type
checking and default positional arguments.

.. code:: python

from argopt import argopt


def main(doc):
parser = argopt(doc, version='0.1.2-3.4')
# parser.print_help()

args = parser.parse_args()
print (args)


if __name__ == '__main__':
doc = '''
Example programme description.
You should be able to do
args = argopt(__doc__).parse_args()
instead of
args = docopt(__doc__)

Usage:
test.py [-h | options] <x> [<y>...]

Arguments:
<x> A file.
--anarg=<a> Description here [default: 1e3:int].
-p PAT, --patts PAT Or [default: None:file].
--bar=<b> Another [default: something] should
auto-wrap something in quotes and assume str.
-f, --force Force.
'''
main(doc)

Advanced usage and examples
~~~~~~~~~~~~~~~~~~~~~~~~~~~

See the `examples <https://github.com/casperdcl/argopt/tree/master/examples>`__
folder.


Documentation
-------------

.. code:: python

def argopt(doc='', argparser=argparse.ArgumentParser, **_kwargs):
"""
Note that `docopt` supports neither type specifiers nor default
positional arguments. We support both here.

Parameters
----------
doc : docopt compatible, with optional type specifiers
[default: '':str]
argparser : Argument parser class [default: argparse.ArgumentParser]
version : Version string [default: None:str]
_kwargs : any `argparser` initialiser arguments


Returns
-------
out : argparser object (default: argparse.ArgumentParser)

Usage
-----
Extension syntax example: [default: 1e3:int].

You should be able to do
parser = argopt(__doc__)
args = parser.parse_args()
instead of
args = docopt(__doc__)

TODO
----
add_argument_group
add_mutually_exclusive_group
(better) subparser support
(docopt extension) action choices
(docopt extension) action count
"""


Contributions
-------------

To run the testing suite please make sure tox (https://testrun.org/tox/latest/)
is installed, then type ``tox`` from the command line.

Where ``tox`` is unavailable, a Makefile-like setup is
provided with the following command:

.. code:: sh

$ python setup.py make alltests

To see all options, run:

.. code:: sh

$ python setup.py make


Licence
-------

OSI approved.

Copyright (c) 2016 Casper da Costa-Luis.

This Source Code Form is subject to the terms of the
Mozilla Public License, v. 2.0.
If a copy of the MPL was not distributed with this file, You can obtain one
at `https://mozilla.org/MPL/2.0/ <https://mozilla.org/MPL/2.0/>`__.


Authors
-------

- Casper da Costa-Luis <casper@caspersci.uk.to>

|Hits|

.. |Build Status| image:: https://travis-ci.org/casperdcl/argopt.svg?branch=master
:target: https://travis-ci.org/casperdcl/argopt
.. |Coverage Status| image:: https://coveralls.io/repos/casperdcl/argopt/badge.svg
:target: https://coveralls.io/r/casperdcl/argopt
.. |Branch Coverage Status| image:: https://codecov.io/github/casperdcl/argopt/coverage.svg?branch=master
:target: https://codecov.io/github/casperdcl/argopt?branch=master
.. |PyPi Status| image:: https://img.shields.io/pypi/v/argopt.svg
:target: https://pypi.python.org/pypi/argopt
.. |Hits| image:: http://caspersci.uk.to/cgi-bin/hits.cgi?q=argopt&a=hidden
:target: http://caspersci.uk.to/cgi-bin/hits.cgi?q=argopt&a=plot&r=https://github.com/casperdcl/argopt
Release History

Release History

This version
History Node

0.3.1

History Node

0.3.0

History Node

0.2.1

History Node

0.2.0

History Node

0.1.0

History Node

0.0.1

Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
argopt-0.3.1-py2.py3-none-any.whl (15.0 kB) Copy SHA256 Checksum SHA256 2.7 Wheel Apr 20, 2016
argopt-0.3.1.tar.gz (17.6 kB) Copy SHA256 Checksum SHA256 Source Apr 20, 2016
argopt-0.3.1.zip (24.5 kB) Copy SHA256 Checksum SHA256 Source Apr 20, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting