mirror of https://github.com/datafolklabs/cement.git synced 2026-02-06 15:26:47 +00:00

Application Framework for Python

Go to file

BJ Dierkes b08c1202e9 Use Read The Docs Theme for Docs		2014-08-20 16:05:31 -05:00
cement	Resolving merge	2014-08-06 19:00:24 -05:00
doc	Use Read The Docs Theme for Docs	2014-08-20 16:05:31 -05:00
scripts	Update travis for py3	2014-01-21 17:02:43 -06:00
tests	Resolves test failures	2014-04-16 14:12:59 -05:00
.coveragerc	Fix coverage issues with ext_daemon	2014-01-29 18:03:52 -06:00
.gitignore	adding test module	2012-07-15 15:11:38 -05:00
.pylintrc	Pylint fixes. Part of Issue #132	2012-09-07 16:44:08 -05:00
.travis.yml	Add memcached to Travis CI services	2014-01-20 19:11:16 -06:00
ChangeLog	Resolving merge	2014-08-06 19:00:24 -05:00
CONTRIBUTORS	Resolves Issue #144	2012-07-30 21:31:30 -05:00
LICENSE	Resolves Issue #202 and #217	2014-01-22 18:09:03 -06:00
README.md	Fix coverage issues with ext_daemon	2014-01-29 18:03:52 -06:00
requirements-dev-py3.txt	Update travis for py3	2014-01-21 17:02:43 -06:00
requirements-dev.txt	Use Read The Docs Theme for Docs	2014-08-20 16:05:31 -05:00
requirements.txt	Adding development requirements	2012-08-03 19:05:02 -05:00
setup.cfg	Define where to find tests	2014-01-21 14:22:17 -06:00
setup.py	Resolves Issue #202 and #217	2014-01-22 18:09:03 -06:00

README.md

Cement CLI Application Framework for Python

Cement is an advanced CLI Application Framework for Python. Its goal is to introduce a standard, and feature-full platform for both simple and complex command line applications as well as support rapid development needs without sacrificing quality.

Cement core features include (but are not limited to):

Core pieces of the framework are customizable via handlers/interfaces
Extension handler interface to easily extend framework functionality
Config handler supports parsing multiple config files into one config
Argument handler parses command line arguments and merges with config
Log handler supports console and file logging
Plugin handler provides an interface to easily extend your application
Hook support adds a bit of magic to apps and also ties into framework
Handler system connects implementation classes with Interfaces
Output handler interface renders return dictionaries to console
Cache handler interface adds caching support for improved performance
Controller handler supports sub-commands, and nested controllers
Zero external dependencies* (not including optional extensions)
100% test coverage using Nose*
100% PEP8 compliant using pep8 and autopep8 tools
Extensive Sphinx documentation
Tested on Python 2.6, 2.7, 3.2, and 3.3

Note that argparse is required as an external dependency for Python < 2.7 and < 3.2. Additionally, some optional extensions that are shipped with the mainline Cement sources do require external dependencies. It is the responsibility of the application developer to include these dependencies along with their application, as Cement explicitly does not include them.

More Information

DOCS: http://builtoncement.com/2.2/
CODE: http://github.com/datafolklabs/cement/
PYPI: http://pypi.python.org/pypi/cement/
SITE: http://builtoncement.com/
T-CI: https://travis-ci.org/datafolklabs/cement
HELP: cement@librelist.org - #cement

License

The Cement CLI Application Framework is Open Source and is distributed under the BSD License (three clause). Please see the LICENSE file included with this software.