Application Framework for Python
Go to file
2009-12-06 16:08:36 -06:00
cement Adding cement-app and cement-plugin commands for PasteScript 2009-12-06 16:08:36 -06:00
etc/plugins.d Merged changes from abg. No longer using exec infavor of __import__ (thank you) 2009-12-06 12:45:17 -06:00
examples Merged changes from abg. No longer using exec infavor of __import__ (thank you) 2009-12-06 12:45:17 -06:00
.gitignore adding .gitignore file 2009-12-05 19:46:10 -06:00
GitChangeLog Adding cement-app and cement-plugin commands for PasteScript 2009-12-06 16:08:36 -06:00
INSTALL Added a PasteScript plugin to quickstart a cement app. 2009-12-06 14:32:52 -06:00
LICENSE cleanup 2009-12-05 19:44:24 -06:00
README Added a PasteScript plugin to quickstart a cement app. 2009-12-06 14:32:52 -06:00
setup.py Adding cement-app and cement-plugin commands for PasteScript 2009-12-06 16:08:36 -06:00
TODO adding TODO 2009-12-05 20:39:28 -06:00

NAME: python-cement

CREATOR/MAINTAINER: BJ Dierkes <wdierkes@5dollarwhitebox.org

DESCRIPTION:

Cement is a basic Python CLI Application Framework.  Almost every command
line type application has a number of basic pieces that have to exist before
any real code and logic gets written.  At a minimum, Cement easily sets up
the following:

    Configuration file parsing [using ConfigObj]
    Command line arguments and option parsing [using OptParse]
    Logging [using Logger]
    Plugin support [partially using setuptools]
    

These four pieces are the most important for a fully functional command
line application.  Normally to accomplish what's listed above would require 
dozens of lines of code before you even begin coding your application.  With 
Cement, the above is configured with more or less a single line of code.

Cement is most generally used as a starting point from which to begin 
developing a command line type application.  That said, applications using
cement can also share plugins with either cement or other applications
using cement.


GETTING STARTED:

There are a number of examples under ./examples.  To see how to get an 
application started with cement, see the CementExample application.  To see
how to write plugins for some-such application using cement see the 
CementExampleMyPlugin which is a plugin for the CementExample application.