Personal fork of https://github.com/datafolklabs/cement

BJ Dierkes 46ead224d2 Resolves Issue #301 9 years ago
cement 46ead224d2 Resolves Issue #301 9 years ago
doc 0227fe41dd Resolves Issue #303 9 years ago
examples 2d1cdf5d2d Resolves Issue #275 10 years ago
scripts 98104c2d60 Update travis for py3 11 years ago
tests c619778bbe Branching 2.4.x Stable 10 years ago
.coveragerc a6684d259c Fix coverage issues with ext_daemon 11 years ago
.gitignore f63d1f34b0 adding test module 12 years ago
.pylintrc 6215478936 Pylint fixes. Part of Issue #132 12 years ago
.travis.yml 527818795f Add memcached to Travis CI services 11 years ago
CONTRIBUTORS 5e1f018015 Resolves Issue #259 10 years ago
ChangeLog c619778bbe Branching 2.4.x Stable 10 years ago
LICENSE bbf2e4e31e Resolves Issue #202 and #217 11 years ago
README.md 1d5673e295 Fix version in README 10 years ago
requirements-dev-py3.txt c49b1fa8d0 Resolves Issue #119 (with tests) 10 years ago
requirements-dev.txt c8a5378e0a Use Read The Docs Theme 10 years ago
requirements.txt 13d15d68c5 Adding development requirements 12 years ago
setup.cfg 2a3d29c0fb Define where to find tests 11 years ago
setup.py bbf2e4e31e Resolves Issue #202 and #217 11 years ago

README.md

Cement Framework

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 is flexible, and it's use cases span from the simplicity of a micro-framework to the complexity of a mega-framework. Whether it's a single file script, or a multi-tier application, Cement is the foundation you've been looking for.

The first commit to Git was on Dec 4, 2009. Since then, the framework has seen several iterations in design, and has continued to grow and improve since it's inception. Cement is the most stable, and complete framework for command line and backend application development.

Continuous Integration Status

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

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.