Developer Documentation

This page contains documentation for developers building their application on Cement. It outlines the features of the Cement Framework and how to use them in your applications.

• An Overview of Features
  • Config File Parsing
  • Command Line Argument and Option Parsing
  • Logging
  • Plugin Support
  • Hook Support
  • Model, View, Controller Design
  • Json Output Rendering - The Cement CLI-API
• Quick Starting a New CLI Application
  • Raw Commands For The Impatient
  • Installing Cement
    • Stable
    • Development
  • Creating The HelloWorld Application
• Understanding Your Application
  • helloworld.core
  • helloworld.bootstrap
  • helloworld.controllers
  • helloworld.lib
  • helloworld.model
  • helloworld.templates
  • helloworld.helpers
• Namespaces
  • Accessing Namespaces
• Hooks
  • Defining a Hook
  • Registering Functions to a Hook
  • Running a hook
  • Controlling Hook Run Order
• Handlers
  • Defining a Handler
  • Registering a Handler
  • Example Usage
• Model, View, Controller Overview
  • The Model
  • The Controller
  • The View
• Command Line Options and Arguments
  • Adding Options To a Namespace
  • Adding Options To Another Namespace
  • Accessing Options and Arguments
  • Alternate Option Examples
• Logging
  • Configuration Settings
  • Using the Logger
  • Configuring Logging via a Config File
• Plugin Support
  • A Look at an Internal Plugin
  • Important Note on Naming Conventions
  • External Plugins
  • Enabling Internal/External Plugins
  • Shared Plugin Support
• Genshi Templating Engine
  • Genshi Syntax Basics
• Cement CLI-API (Rendered JSON Output)
  • Pretty Printing JSON
• Nose Testing Your Application
  • Running Tests
  • Creating a Nose Test
• Documenting Your Application
  • Generating the Docs