Skip to content

Latest commit

 

History

History
78 lines (59 loc) · 2.63 KB

index.rst

File metadata and controls

78 lines (59 loc) · 2.63 KB

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.

image

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* of the core library
  • 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 if they intend to use any optional extensions that have external dependencies, as Cement explicitly does not include them.

Getting More Information

Documentation

changes license contributors upgrading faq api/index

dev/index

examples/index