mirror of
https://github.com/datafolklabs/cement.git
synced 2026-02-06 17:01:58 +00:00
78 lines
2.7 KiB
ReStructuredText
78 lines
2.7 KiB
ReStructuredText
.. Cement documentation master file, created by
|
|
sphinx-quickstart on Mon Aug 22 17:52:04 2011.
|
|
You can adapt this file completely to your liking, but it should at least
|
|
contain the root `toctree` directive.
|
|
|
|
Cement CLI Application Framework for Python
|
|
===========================================
|
|
|
|
.. warning:: This documentation is for the development version of Cement
|
|
2.1.x. For production please use, and reference the current stable version of
|
|
`Cement 2.0.x <http://builtoncement.com/2.0/>`_.
|
|
|
|
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.
|
|
|
|
.. image:: https://secure.travis-ci.org/cement/cement.png
|
|
:target: https://travis-ci.org/#!/cement/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* (ext's with dependencies ship separately)
|
|
* 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.*
|
|
|
|
Getting More Information
|
|
------------------------
|
|
|
|
* DOCS: http://builtoncement.com/2.1/
|
|
* CODE: http://github.com/cement/
|
|
* PYPI: http://pypi.python.org/pypi/cement/
|
|
* SITE: http://builtoncement.com/
|
|
* T-CI: http://travis-ci.org/cement/cement
|
|
* HELP: cement@librelist.org - #cement
|
|
|
|
Documentation
|
|
-------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
changes
|
|
license
|
|
contributors
|
|
api/index
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
dev/index
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
examples/index
|
|
|
|
|