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.

• Installation
  • Installation
  • Running Tests
  • Building Documentation
• Quick Start
  • Getting Warmer
  • Diving Right In
• Interfaces and Handlers
  • Defining an Interface
  • Validating Interfaces
  • Registering Handlers to an Interface
  • Using Handlers
  • Overriding Default Handlers
  • Multiple Registered Handlers
  • Customizing Handlers
  • Handler Default Configuration Settings
  • Overriding Handlers Via Command Line
• Configuration Handling
  • Configuration Ordering
  • Application Default Settings
  • Built-in Defaults
  • Application Configuration Defaults vs Handler Configuration Defaults
  • Accessing Configuration Settings
  • Parsing Config Files
  • Overriding Configurations with Command Line Options
  • Configuration Options Versus Meta Options
• Argument and Option Handling
  • Adding Arguments
  • Accessing Parsed Arguments
• Log Handling
  • Logging Messages
  • Changing Log Level
  • Logging to Console
  • Logging to a File
  • Tips on Debugging
• Output Handling
  • Rending Output
  • Rendering Output Via Templates
• Application Controllers
  • Example Application Base Controller
  • Additional Controllers and Namespaces
• Framework Extensions
  • Extension Configuration Settings
  • Creating an Extension
  • Loading an Extension
  • Loading Extensions Via a Configuration File
• Application Plugins
  • Plugin Configuration Settings
  • Creating a Plugin
  • Loading a Plugin
  • User Defined Plugin Configuration and Module Directories
  • What Can Go Into a Plugin?
  • Single File Plugins vs. Plugin Directories
  • Loading Templates From Plugin Directories
• Framework and Application Hooks
  • Defining a Hook
  • Registering Functions to a Hook
  • Running a hook
  • Controlling Hook Run Order
  • Cement Framework Hooks
    • pre_setup
    • post_setup
    • pre_run
    • post_run
    • pre_argument_parsing
    • post_argument_parsing
    • pre_render
    • post_render
    • pre_close
    • post_close
    • signal
• Extending CementApp
• Signal Handling
  • Signals Caught by Default
  • Using The Signal Hook
  • Configuring Which Signals To Catch
  • What If I Don’t Like Your Signal Handler Callback?
  • This Is Stupid, and UnPythonic - How Do I Disable It?
• Application Cleanup
  • Exit Status and Error Codes
  • Running Cleanup Code
• Caching
  • General Usage
• Sending Email Messages
  • Example Usage
• Unit Testing Your Application
  • An Example Test Case
  • Cement Testing Caveats
• Application Design
  • Single File Scripts
  • Multi-File Applications
  • Handling High Level Exceptions
• Starting Projects from Boss Templates
  • Creating a Cement App
  • Creating a Cement Plugin
  • Creating a Cement Extension
• Contributing
  • Licensing
  • Submitting Bug Reports and Feature Requests
  • Guidelines for Code Contributions
  • Source Code and Versioning