Metadata-Version: 2.1
Name: cli-command-parser
Version: 2022.8.27.post1
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
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.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: ~=3.7
Provides-Extra: dev
Provides-Extra: docs
License-File: LICENSE

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

|downloads| |py_version| |coverage_badge| |build_status| |Blue|

.. |py_version| image:: https://img.shields.io/badge/python-3.7%20%7C%203.8%20%7C%203.9%20%7C%203.10%20%7C%203.11%20-blue
    :target: https://pypi.org/project/cli-command-parser/

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

.. |Blue| image:: https://img.shields.io/badge/code%20style-blue-blue.svg
    :target: https://blue.readthedocs.io/

.. |downloads| image:: https://img.shields.io/pypi/dm/cli-command-parser
    :target: https://pypistats.org/packages/cli-command-parser


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


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

CLI Command Parser is available on PyPI::

    $ pip install cli-command-parser


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

User & API `documentation <https://dskrypa.github.io/cli_command_parser/index.html>`_ is available.

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