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.
Raw data
{
"_id": null,
"home_page": "https://cmdkit.readthedocs.io",
"name": "cmdkit",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "command-line, utility, toolkit",
"author": "Geoffrey Lentner",
"author_email": "glentner@purdue.edu",
"download_url": "https://files.pythonhosted.org/packages/a9/8d/0483d6018a5293ef74889ee132b243d34c324be19378acb93341bbefb43b/cmdkit-2.7.7.tar.gz",
"platform": null,
"description": "CmdKit\n======\n\nA library for developing command-line applications in Python.\n\n.. image:: https://img.shields.io/badge/license-Apache-yellow.svg?style=flat\n :target: https://www.apache.org/licenses/LICENSE-2.0\n :alt: License\n\n.. image:: https://img.shields.io/pypi/v/cmdkit.svg?style=flat&color=blue\n :target: https://pypi.org/project/cmdkit\n :alt: PyPI Version\n\n.. image:: https://img.shields.io/pypi/pyversions/cmdkit.svg?logo=python&logoColor=white&style=flat\n :target: https://pypi.org/project/cmdkit\n :alt: Python Versions\n\n.. image:: https://readthedocs.org/projects/cmdkit/badge/?version=latest&style=flat\n :target: https://cmdkit.readthedocs.io\n :alt: Documentation\n\n.. image:: https://github.com/glentner/cmdkit/actions/workflows/tests.yml/badge.svg\n :target: https://github.com/glentner/cmdkit/actions/workflows/tests.yml\n :alt: Tests\n\n.. image:: https://pepy.tech/badge/cmdkit\n :target: https://pepy.tech/badge/cmdkit\n :alt: Downloads\n\n|\n\nThe *cmdkit* library implements a few common patterns needed by well-formed command-line\napplications in Python. It only touches a few concepts but it implements them well.\nThe idea is to reduce the boilerplate needed to get a full featured CLI off the ground.\nApplications developed using *cmdkit* are easy to implement, easy to maintain, and easy to\nunderstand.\n\n|\n\nInstallation\n------------\n\n*CmdKit* is tested for `Windows`, `macOS`, and `Linux`, and can be installed\nfrom the `Python Package Index` using `Pip`.\n\n::\n\n $ pip install cmdkit\n\n|\n\nDocumentation\n-------------\n\nDocumentation for getting started, the API, and common recipes are available at\n`cmdkit.readthedocs.io <https://cmdkit.readthedocs.io>`_.\n\n|\n\nContributions\n-------------\n\nContributions are welcome in the form of suggestions for additional features, pull requests with\nnew features or bug fixes, etc. If you find bugs or have questions, open an *Issue* here. If and\nwhen the project grows, a code of conduct will be provided along side a more comprehensive set of\nguidelines for contributing; until then, just be nice.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "A command-line utility toolkit for Python.",
"version": "2.7.7",
"project_urls": {
"Documentation": "https://cmdkit.readthedocs.io",
"Homepage": "https://cmdkit.readthedocs.io",
"Repository": "https://github.com/glentner/cmdkit"
},
"split_keywords": [
"command-line",
" utility",
" toolkit"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2362c82680c31dc2dcfa55918a28720d2e5695cbb4e778b621416d12883203cd",
"md5": "bf43a5f75ba619efbb34380e96bfce1d",
"sha256": "9dfb1ae63329d0ce1970886206ef14a9773d5ebcc15608c96df119bc82abf023"
},
"downloads": -1,
"filename": "cmdkit-2.7.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bf43a5f75ba619efbb34380e96bfce1d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 26819,
"upload_time": "2024-12-28T21:21:54",
"upload_time_iso_8601": "2024-12-28T21:21:54.931051Z",
"url": "https://files.pythonhosted.org/packages/23/62/c82680c31dc2dcfa55918a28720d2e5695cbb4e778b621416d12883203cd/cmdkit-2.7.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a98d0483d6018a5293ef74889ee132b243d34c324be19378acb93341bbefb43b",
"md5": "0ea0623a45990843f70296fbe87afc13",
"sha256": "afe20b60ee60658e299dba465248b74c1801bfe24f891ef745b3a6810251c280"
},
"downloads": -1,
"filename": "cmdkit-2.7.7.tar.gz",
"has_sig": false,
"md5_digest": "0ea0623a45990843f70296fbe87afc13",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 23225,
"upload_time": "2024-12-28T21:21:57",
"upload_time_iso_8601": "2024-12-28T21:21:57.080894Z",
"url": "https://files.pythonhosted.org/packages/a9/8d/0483d6018a5293ef74889ee132b243d34c324be19378acb93341bbefb43b/cmdkit-2.7.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-28 21:21:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "glentner",
"github_project": "cmdkit",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "cmdkit"
}
JSON
