Cement CLI Application Framework v2 Beta

Cement2 is an advanced CLI Application Framework for Python, and a complete rewrite of Cement version 0.x/1.x. 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.

Cement2 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
• Core library and extensions have zero external dependencies*
• Extensions with external dependencies packaged separately
• Controller handler supports sub-commands, and nested controllers
• 98% Nose test coverage
• Extensive Sphinx documentation
• Tested on Python 2.6, 2.7, 3.1, and 3.2

Cement2 extensions include:

• JSON output handler extension (adds –json option)
• YAML output handler extension (adds –yaml option)
• ConfigObj config handler extension replaces ConfigParser
• Daemon extension handles background processes (adds –daemon option)
• Genshi output handler extension provides Text Templating
• Memcached cache handler extension provides easy caching

Note that argparse is required as an external dependency for Python < 2.7 and < 3.2. Some extensions rely on external dependencies.

Other sites that might be helpful.

• RTFD: http://cement.readthedocs.org/en/portland/
• CODE: https://github.com/derks/cement/tree/portland
• PYPI: http://pypi.python.org/pypi/cement2
• IRC: #cement
• CI: http://travis-ci.org/#!/derks/cement

Older Versions of Cement:

The previous stable branch of Cement is 0.8. It is no longer under active development, and only critical bugs will be addressed.

• RTFD: http://cement.rtfd.org/en/latest/
• CODE: http://github.com/derks/cement
• PYPI: http://pypi.python.org/pypi/cement

Contents

• ChangeLog
• License
• Versioning and Compatibility
• Features

• API Documentation
  • Cement2 Core Modules
  • Cement2 Extensions

• Developer Documentation
  • Quick Start
  • Interfaces and Handlers
  • Framework Extensions
  • Configuration Handling
  • Log Handling
  • Argument and Option Handling
  • Output Handling
  • Application Controllers
  • Framework and Application Hooks
  • Application Plugins
  • Signal Handling
  • Application Cleanup
  • Cache Handling
  • Examples