Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/casperdcl/argopt

convert docopt to argparse
https://github.com/casperdcl/argopt
cli developer-tools docopt hacktoberfest hacktoberfest2021 python
Last synced: about 2 hours ago
JSON representation
convert docopt to argparse
Host: GitHub
URL: https://github.com/casperdcl/argopt
Owner: casperdcl
License: other
Created: 2016-04-19T20:17:22.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2023-02-21T20:40:21.000Z (over 1 year ago)
Last Synced: 2024-09-21T13:13:56.748Z (12 days ago)
Topics: cli, developer-tools, docopt, hacktoberfest, hacktoberfest2021, python
Language: Python
Homepage: https://pypi.python.org/pypi/argopt
Size: 193 KB
Stars: 22
Watchers: 2
Forks: 2
Open Issues: 5
Metadata Files:
- Readme: README.rst
- Funding: .github/FUNDING.yml
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project

README

        argopt

======

doc to ``argparse`` driven by ``docopt``

|Py-Versions| |PyPI| |Conda-Forge|

|Build-Status| |Coverage-Status| |Branch-Coverage-Status| |Codacy-Grade| |Libraries-Rank| |PyPI-Downloads|

|LICENCE| |OpenHub-Status| |Gift-Casper|

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

`shtab `__ or

`Gooey `__ but with the simple syntax of

`docopt `__.

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

.. contents:: Table of contents

   :backlinks: top

   :local:

Installation

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

Latest PyPI stable release

~~~~~~~~~~~~~~~~~~~~~~~~~~

|PyPI| |PyPI-Downloads| |Libraries-Dependents|

.. code:: sh

    pip install argopt

Latest development release on GitHub

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

|GitHub-Status| |GitHub-Stars| |GitHub-Commits| |GitHub-Forks| |GitHub-Updated|

Pull and install:

.. code:: sh

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

Latest Conda release

~~~~~~~~~~~~~~~~~~~~

|Conda-Forge|

.. code:: sh

    conda install -c conda-forge argopt

Changelog

---------

The list of all changes is available on the Releases page: |GitHub-Status|.

Usage

-----

Standard `docopt `__ docstring syntax applies.

Additionally, some improvements and enhancements are supported, such as type

checking and default positional arguments.

.. code:: python

    '''Example programme description.

    You should be able to do

        args = argopt(__doc__).parse_args()

    instead of

        args = docopt(__doc__)

    Usage:

        test.py [options]  [...]

    Arguments:

                           A file.

        --anarg=           Description here [default: 1e3:int].

        -p PAT, --patts PAT   Or [default: None:file].

        --bar=             Another [default: something] should

                              auto-wrap something in quotes and assume str.

        -f, --force           Force.

    '''

    from argopt import argopt

    __version__ = "0.1.2-3.4"


    parser = argopt(__doc__, version=__version__)

    args = parser.parse_args()

    if args.force:

        print(args)

    else:

        print(args.x)

For comparison, the `docopt` equivalent would be:

.. code:: python

    '''Example programme description.

    Usage:

        test.py [options]  [...]

    Arguments:

                           A file.

        --anarg=           int, Description here [default: 1e3].

        -p PAT, --patts PAT   file, Or (default: None).

        --bar=             str, Another [default: something] should

                              assume str like everything else.

        -f, --force           Force.

        -h, --help            Show this help message and exit.

        -v, --version         Show program's version number and exit.


    '''

    from docopt import docopt

    __version__ = "0.1.2-3.4"

    args = docopt(__doc__, version=__version__)

    args["--anarg"] = int(eval(args["--anarg"]))

    if args["--patts"]:

        args["--patts"] = open(args["--patts"])

    if args["--force"]:

        print(args)

    else:

        print(args[""])

Advanced usage and examples

~~~~~~~~~~~~~~~~~~~~~~~~~~~

See the `examples `__

folder.

Documentation

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

|Py-Versions| |README-Hits|

.. code:: python

    def argopt(doc='', argparser=ArgumentParser,

               formatter_class=RawDescriptionHelpFormatter,

               logLevel=logging.NOTSET, **_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]

      formatter_class  : [default: argparse.RawDescriptionHelpFormatter]

      logLevel  : [default: logging.NOTSET]

      _kwargs  : any `argparser` initialiser arguments

          N.B.: `prog`, `description`, and `epilog` are automatically

          inferred if not `None`

      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

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

|GitHub-Commits| |GitHub-Issues| |GitHub-PRs| |OpenHub-Status|

All source code is hosted on `GitHub `__.

Contributions are welcome.

LICENCE

-------

Open Source (OSI approved): |LICENCE|

Authors

-------

|OpenHub-Status|

- Casper da Costa-Luis (`casperdcl `__ |Gift-Casper|)

We are grateful for all |GitHub-Contributions|.

|README-Hits|

.. |Build-Status| image:: https://img.shields.io/github/actions/workflow/status/casperdcl/argopt/test.yml?branch=master&label=argopt&logo=GitHub

   :target: https://github.com/casperdcl/argopt/actions/workflows/test.yml

.. |Coverage-Status| image:: https://img.shields.io/coveralls/github/casperdcl/argopt/master?logo=coveralls

   :target: https://coveralls.io/github/casperdcl/argopt

.. |Branch-Coverage-Status| image:: https://codecov.io/gh/casperdcl/argopt/branch/master/graph/badge.svg

   :target: https://codecov.io/gh/casperdcl/argopt

.. |Codacy-Grade| image:: https://api.codacy.com/project/badge/Grade/5282d52c142d4c6ea24f978b03981c6f

   :target: https://app.codacy.com/gh/casperdcl/argopt

.. |GitHub-Status| image:: https://img.shields.io/github/tag/casperdcl/argopt.svg?maxAge=86400&logo=github

   :target: https://github.com/casperdcl/argopt/releases

.. |GitHub-Forks| image:: https://img.shields.io/github/forks/casperdcl/argopt.svg?logo=github

   :target: https://github.com/casperdcl/argopt/network

.. |GitHub-Stars| image:: https://img.shields.io/github/stars/casperdcl/argopt.svg?logo=github

   :target: https://github.com/casperdcl/argopt/stargazers

.. |GitHub-Commits| image:: https://img.shields.io/github/commit-activity/y/casperdcl/argopt?label=commits&logo=git

   :target: https://github.com/casperdcl/argopt/graphs/commit-activity

.. |GitHub-Issues| image:: https://img.shields.io/github/issues-closed/casperdcl/argopt.svg?logo=github

   :target: https://github.com/casperdcl/argopt/issues

.. |GitHub-PRs| image:: https://img.shields.io/github/issues-pr-closed/casperdcl/argopt.svg?logo=github

   :target: https://github.com/casperdcl/argopt/pulls

.. |GitHub-Contributions| image:: https://img.shields.io/github/contributors/casperdcl/argopt.svg?logo=github

   :target: https://github.com/casperdcl/argopt/graphs/contributors

.. |GitHub-Updated| image:: https://img.shields.io/github/last-commit/casperdcl/argopt?label=pushed&logo=github

   :target: https://github.com/casperdcl/argopt/pulse

.. |Gift-Casper| image:: https://img.shields.io/badge/gift-donate-dc10ff.svg?logo=Contactless%20Payment

   :target: https://caspersci.uk.to/donate

.. |PyPI| image:: https://img.shields.io/pypi/v/argopt.svg?logo=PyPI&logoColor=white

   :target: https://pypi.org/project/argopt

.. |PyPI-Downloads| image:: https://img.shields.io/pypi/dm/argopt.svg?label=pypi%20downloads&logo=DocuSign

   :target: https://pypi.org/project/argopt

.. |Py-Versions| image:: https://img.shields.io/pypi/pyversions/argopt.svg?logo=python&logoColor=white

   :target: https://pypi.org/project/argopt

.. |Conda-Forge| image:: https://img.shields.io/conda/v/conda-forge/argopt.svg?label=conda-forge&logo=conda-forge

   :target: https://anaconda.org/conda-forge/argopt

.. |Libraries-Rank| image:: https://img.shields.io/librariesio/sourcerank/pypi/argopt.svg?color=green&logo=koding

   :target: https://libraries.io/pypi/argopt

.. |Libraries-Dependents| image:: https://img.shields.io/librariesio/dependent-repos/pypi/argopt.svg?logo=koding

    :target: https://github.com/casperdcl/argopt/network/dependents

.. |OpenHub-Status| image:: https://www.openhub.net/p/arg-opt/widgets/project_thin_badge?format=gif

   :target: https://www.openhub.net/p/arg-opt?ref=Thin+badge

.. |LICENCE| image:: https://img.shields.io/pypi/l/argopt.svg?color=purple&logo=SPDX

   :target: https://raw.githubusercontent.com/casperdcl/argopt/master/LICENCE

.. |README-Hits| image:: https://caspersci.uk.to/cgi-bin/hits.cgi?q=argopt&style=social&r=https://github.com/casperdcl/argopt

   :target: https://caspersci.uk.to/cgi-bin/hits.cgi?q=argopt&a=plot&r=https://github.com/casperdcl/argopt&style=social