Metadata-Version: 2.1
Name: cli-command-parser
Version: 2022.5.14
Summary: CLI Command Parser
Home-page: https://github.com/dskrypa/cli_command_parser
Author: Doug Skrypa
Author-email: dskrypa@gmail.com
License: Apache 2.0
Project-URL: Source, https://github.com/dskrypa/cli_command_parser
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: ~=3.9
License-File: LICENSE
Provides-Extra: dev
Requires-Dist: pre-commit ; extra == 'dev'
Requires-Dist: ipython ; extra == 'dev'
Requires-Dist: sphinx ; extra == 'dev'
Requires-Dist: sphinx-rtd-theme ; extra == 'dev'
Requires-Dist: sphinx-paramlinks ; extra == 'dev'
Requires-Dist: testtools ; extra == 'dev'
Requires-Dist: coverage ; extra == 'dev'
Provides-Extra: docs
Requires-Dist: sphinx ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme ; extra == 'docs'
Requires-Dist: sphinx-paramlinks ; extra == 'docs'

******************
CLI Command Parser
******************

|py_version| |coverage_badge| |build_status| |Black|

.. |py_version| image:: https://img.shields.io/badge/python-3.9%20%7C%203.10%20-blue

.. |coverage_badge| image:: https://codecov.io/gh/dskrypa/cli_command_parser/branch/main/graph/badge.svg
    :target: https://codecov.io/gh/dskrypa/cli_command_parser

.. |build_status| image:: https://github.com/dskrypa/cli_command_parser/actions/workflows/run-tests.yml/badge.svg
    :target: https://github.com/dskrypa/cli_command_parser/actions/workflows/run-tests.yml

.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black


Command Parser is a class-based CLI argument parser that defines parameters with descriptors.

The primary goals of this project:
  - Make it easy to define subcommands and actions in an clean and organized manner
  - Allow for inheritance so that common parameters don't need to be repeated
  - Make it easy to handle common initialization tasks for all actions / subcommands once
  - Reduce the amount of boilerplate code that is necessary for setting up parsing and handling argument values


This project is still a work in progress.


Installing CLI Command Parser
-----------------------------

CLI Command Parser is available on PyPI::

    $ pip install cli-command-parser


Documentation & Examples
------------------------

`API documentation <https://dskrypa.github.io/cli_command_parser/>`_ is currently available.  More detailed usage guides
are coming soon.

Example scripts using CLI Command Parser can be found in the `examples
<https://github.com/dskrypa/cli_command_parser/tree/main/examples>`_ directory.


