Metadata-Version: 2.1
Name: cmdkit
Version: 1.3.0
Summary: A commandline utility toolkit.
Home-page: https://cmdkit.readthedocs.io
Author: Geoffrey Lentner
Author-email: <glentner@gmail.com>
License: Apache License
Keywords: command-line utility toolkit
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: License :: OSI Approved :: Apache Software License
Description-Content-Type: text/markdown
Requires-Dist: logalpha (>=2.0.2)
Provides-Extra: toml
Requires-Dist: toml ; extra == 'toml'
Provides-Extra: yaml
Requires-Dist: pyyaml ; extra == 'yaml'

CmdKit
======

CmdKit is a library for developing command line utilities in Python.

[![GitHub License](http://img.shields.io/badge/license-Apache-blue.svg?style=flat)](https://www.apache.org/licenses/LICENSE-2.0)
[![PyPI Version](https://img.shields.io/pypi/v/cmdkit.svg)](https://pypi.org/project/cmdkit/)
[![Docs Latest](https://readthedocs.org/projects/cmdkit/badge/?version=latest)](https://cmdkit.readthedocs.io)

---

Installation
------------

To install CmdKit for general purposes use Pip:

```
pip install cmdkit
```


Documentation
-------------

Documentation will be available at [cmdkit.readthedocs.io](https://cmdkit.readthedocs.io).
Currently, development of additional features is a priority, but this is a great place for
contributing to the project.


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.


Road Map
--------

- **additional unit tests**<br>
	Basic unit testing exists for the `Application`, `Interface` and `Daemon` classes. More comprehensive
	coverage of unit tests needs to be developed.

- **documentation and package management**<br>
	Comprehensive documentation of the API and a few recipes for using the library.



