cmdkit

CmdKit

A library for developing command-line applications in Python.

.. image:: https://img.shields.io/badge/license-Apache-yellow.svg?style=flat :target: https://www.apache.org/licenses/LICENSE-2.0 :alt: License

.. image:: https://img.shields.io/pypi/v/cmdkit.svg?style=flat&color=blue :target: https://pypi.org/project/cmdkit :alt: PyPI Version

.. image:: https://img.shields.io/pypi/pyversions/cmdkit.svg?logo=python&logoColor=white&style=flat :target: https://pypi.org/project/cmdkit :alt: Python Versions

.. image:: https://readthedocs.org/projects/cmdkit/badge/?version=latest&style=flat :target: https://cmdkit.readthedocs.io :alt: Documentation

.. image:: https://github.com/glentner/cmdkit/actions/workflows/tests.yml/badge.svg :target: https://github.com/glentner/cmdkit/actions/workflows/tests.yml :alt: Tests

.. image:: https://pepy.tech/badge/cmdkit :target: https://pepy.tech/badge/cmdkit :alt: Downloads

|

The cmdkit library implements a few common patterns needed by well-formed command-line applications in Python. It only touches a few concepts but it implements them well. The idea is to reduce the boilerplate needed to get a full featured CLI off the ground. Applications developed using cmdkit are easy to implement, easy to maintain, and easy to understand.

|

Installation

CmdKit is tested for Windows, macOS, and Linux, and can be installed from the Python Package Index using Pip.

::

$ pip install cmdkit

|

Documentation

Documentation for getting started, the API, and common recipes are available at cmdkit.readthedocs.io <https://cmdkit.readthedocs.io>_.

|

Contributions

Contributions are welcome in the form of suggestions for additional features, pull requests with new features or bug fixes, etc. If you find bugs or have questions, open an Issue here. If and when the project grows, a code of conduct will be provided along side a more comprehensive set of guidelines for contributing; until then, just be nice.