repoze.bfg

repoze.bfg is a Python web application framework. It is inspired by Zope’s publisher, though it is less ambitious in scope. It relies heavily on Zope libraries and WSGI.

repoze.bfg is developed as part of the Repoze project by Agendaless Consulting and other contributors. It is licensed under a BSD-like license.

Narrative documentation

Narrative documentation in chapter form explaining how to use repoze.bfg.

• repoze.bfg Introduction
  • Similarities with Other Frameworks
  • Why?

• Installing repoze.bfg
  • How To Install
  • Creating a Virtualenv
  • Installing repoze.bfg Into A Virtualenv
  • What Gets Installed
  • If You Can’t Install Via easy_install (Alternate Installation)

• Creating a repoze.bfg Project
  • Creating the Project
  • Installing your Newly Created Project for Development
  • Running The Tests For Your Application
  • Runnning The Project Application
  • Viewing the Application
  • The Project Structure
  • The MyProject project
  • The myproject package

• Startup
  • The Startup Process

• Mapping URLs to Code
  • Differences Between Traversal and URL Dispatch

• Traversal
  • The Model Graph
  • How repoze.bfg Processes a Request Using Traversal
  • NotFound Errors
  • A Traversal Example
  • Traversal-Related Side Effects

• URL Dispatch
  • Concept and Usage
  • Example 1
  • Example 2
  • Further Documentation and Examples

• Views
  • Defining a View as a Function
  • Mapping Views to URLs
  • Using Model Interfaces
  • The bfg:view ZCML Element
  • View Request Types
  • View Security
  • Using a View to Do A HTTP Redirect

• Templates
  • Templating With chameleon (chameleon.zpt) Page Templates
  • Templating with XSLT
  • Automatically Reloading Templates
  • Using Text Templates
  • Templating with other Templating Languages

• Models
  • Defining a Model
  • Models Which Implement Interfaces
  • Defining a Graph of Model Instances
  • Location-Aware Model Instances
  • repoze.bfg API Functions That Act Against Models

• Security
  • Enabling a Security Policy
  • Protecting Views with Permissions
  • Assigning ACLs to your Model Objects
  • ACL Inheritance
  • Location-Awareness
  • Debugging View Authorization Failures
  • Debugging Imperative Authorization Failures

• Using Events
  • Using An Event to Vary the Request Type

• Environment and Configuration
  • Examples

• Unit Testing
  • Using the repoze.bfg.testing API

• repoze.bfg Change History

• Glossary

Tutorials

Step-by-step tutorials which demonstrate how you might use repoze.bfg.

lxmlgraph Tutorial

• lxmlgraph: Publishing An XML Tree with repoze.bfg
  • Background
    • What It Does
    • How It Works
  • Step 1: Getting Started
  • Step 2: Hello World as XML
    • samplemodel.xml
    • Module models.py
    • Module views.py
    • Browsing the Model
  • Step 3: Basic Rendering With ZPT and XSLT
    • ZPT Templates
    • XSLT Templates
  • Step 4: Hierarchical Rendering With XSLT
    • Pre-Flight Cleanup
    • Design Change: Trees and Context IDs
    • samplemodel.xml
    • views.py
    • xsltview.xsl
    • Conclusion

repoze.bfg for Zope CMF Developers

• Converting an Existing Zope/CMF Application to repoze.bfg
  • Content Types
    • Factory Type Information
  • Catalog
    • Creating an Allowed Index
  • Skins
  • Actions
  • Workflow

API documentation

Per-module repoze.bfg API documentation.

• repoze.bfg.events

• repoze.bfg.push

• repoze.bfg.router

• repoze.bfg.security

• repoze.bfg Built-in Templating Facilties
  • repoze.bfg.chameleon_zpt
  • repoze.bfg.chameleon_genshi
  • repoze.bfg.chameleon_text
  • repoze.bfg.xslt

• repoze.bfg.testing

• repoze.bfg.traversal

• repoze.bfg.location

• repoze.bfg.urldispatch

• repoze.bfg.view

• repoze.bfg.wsgi

Sample Applications

repoze.wiki is a port of the TurboGears 20-Minute Wiki. It demonstrates integration with SQLAlchemy, customized traversal, and form processing. Check this application out of Subversion via:

svn co http://svn.repoze.org/repoze.wiki/trunk repoze.wiki

repoze.cluegun is a simple pastebin application based on Rocky Burt’s ClueBin. It demonstrates form processing, security, and the use of ZODB within a repoze.bfg application. It also has very simple repoze.who integration. Check this application out of Subversion via:

svn co http://svn.repoze.org/repoze.cluegun/trunk repoze.cluegun

repoze.virginia is a very simple dynamic file rendering application. It is willing to render structured text documents, HTML documents, and images from a filesystem directory. This application runs the repoze.org website. Check this application out of Subversion via:

svn co http://svn.repoze.org/repoze.virginia/trunk repoze.virginia

repoze.shootout is an example “idea competition” application by Carlos de la Guardia. It demonstrates URL dispatch and integration with SQLAlchemy and repoze.who. Check this application out of Subversion via:

svn co http://svn.repoze.org/repoze.shootout/trunk repoze.shootout

Support and Development

To report bugs, use the Repoze bug tracker.

If you’ve got questions that aren’t answered by this documentation, contact the Repoze-dev maillist or join the #repoze IRC channel.

Browse and check out tagged and trunk versions of repoze.bfg via the Repoze Subversion repository. To check out the trunk via Subversion, use this command:

svn co http://svn.repoze.org/repoze.bfg/trunk repoze.bfg

To find out how to become a contributor to repoze.bfg, please see the contributor’s page.

Indices and tables

• Index
• Module Index
• Search Page
• Glossary