https://github.com/glentner/cmdkit
A library for developing command-line applications in Python.
https://github.com/glentner/cmdkit
cli library python
Last synced: about 1 year ago
JSON representation
A library for developing command-line applications in Python.
- Host: GitHub
- URL: https://github.com/glentner/cmdkit
- Owner: glentner
- License: apache-2.0
- Created: 2019-06-20T16:53:23.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-12-28T21:20:50.000Z (over 1 year ago)
- Last Synced: 2025-05-07T23:07:19.385Z (about 1 year ago)
- Topics: cli, library, python
- Language: Python
- Homepage: https://cmdkit.readthedocs.io
- Size: 853 KB
- Stars: 4
- Watchers: 2
- Forks: 4
- Open Issues: 4
-
Metadata Files:
- Readme: README.rst
- Contributing: docs/contributing.rst
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
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 `_.
|
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.