Developer Documentation

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

• Quick Start
  • Development Environment
  • Installing From Git
  • A Simple Hello World Application
  • 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
  • Hander Default Configuration Settings
• Framework Extensions
  • Extension Configuration Settings
  • Creating an Extension
  • Loading an Extension
• Configuration Handling
  • Configuration Ordering
  • Application Default Settings
  • Builtin Defaults
  • Accessing Configuration Settings
  • Parsing Config Files
  • Overriding Configurations with Command Line Options
  • Configuration Options Versus Meta Options
• Log Handling
  • Logging Messages
  • Changing Log Level
  • Logging to Console
  • Logging to a File
• Argument and Option Handling
  • Adding Arguments
  • Accessing Parsed Arguments
• Output Handling
  • Rending Output
• Application Controllers
  • Example Application Base Controller
  • Additional Controllers and Namespaces
• Framework and Application Hooks
  • Defining a Hook
  • Registering Functions to a Hook
  • Running a hook
  • Controlling Hook Run Order
  • Cement Framework Hooks
    • cement_pre_setup_hook
    • cement_post_setup_hook
    • cement_pre_run_hook
    • cement_post_run_hook
    • cement_pre_render_hook
    • cement_post_render_hook
    • cement_on_close_hook
    • cement_signal_hook
• Application Plugins
  • Plugin Configuration Settings
    • plugin_config_dir
    • plugin_dir
    • plugin_bootstrap
  • Creating a Plugin
  • Loading a Plugin
• 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
  • Running Cleanup Code
• Cache Handling
  • General Usage
• Examples
  • Multiple Stacked and Non-Stacked Controllers
  • Abstract Base Controllers for Shared Arguments and Commands