Pyramid Documentation

Getting Started

If you are new to Pyramid, we have a few resources that can help you get up to speed right away:

• Check out our FAQ.
• To see a minimal Pyramid web application, check out creating your first Pyramid application.
• For help getting Pyramid set up, try the install guide.
• To get the feel of how a Pyramid web application is created, go to the single file tasks tutorial page.
• Like learning by example? Check out to the wiki tutorial.
• Need help? See Support.

Main Documentation

• Pyramid documentation 1.4 (1.4 PDF) (1.4 Epub) - narrative and API documentation for Pyramid’s current alpha/beta release.
• Pyramid documentation 1.3 (1.3 PDF) (1.3 Epub) - narrative and API documentation for Pyramid’s current stable release.
• Pyramid documentation 1.2 (1.2 PDF) (1.2 Epub) - narrative and API documentation for Pyramid’s 1.2 version.
• Pyramid documentation 1.1 (1.1 PDF) (1.1 Epub) - narrative and API documentation for Pyramid’s 1.1 version.
• Pyramid documentation 1.0 (1.0 PDF) (1.0 Epub) - narrative and API documentation for Pyramid’s 1.0 version.
• Pyramid development documentation - narrative and API documentation for Pyramid’s unreleased in-development version.
• The Pyramid Tutorials presents tutorial resources for Pyramid.
• The Pyramid Cookbook presents topical, practical usages of Pyramid. The cookbook is unfinished.

Pyramid Add-On Documentation

Pyramid supports extensibility through add-ons. The following add-ons are officially endorsed by the Pylons Project, and their documentation is hosted here.

• pyramid_beaker: Beaker session backend plug-in.
  • Maintained by: Ben Bangert, Chris McDonough
  • Version Control: https://github.com/Pylons/pyramid_beaker
• pyramid_debugtoolbar, an interactive HTML debug toolbar for Pyramid.
  • Maintained by: Chris McDonough, Blaise Laflamme
  • Version Control: https://github.com/Pylons/pyramid_debugtoolbar
• pyramid_exclog, a package which logs exceptions from Pyramid applications.
  • Maintained by: Chris McDonough
  • Version Control: https://github.com/Pylons/pyramid_exclog
• pyramid_handlers: analogue of Pylons-style “controllers” for Pyramid.
  • Maintained by: Ben Bangert, Chris McDonough
  • Version Control: https://github.com/Pylons/pyramid_handlers
• pyramid_jinja2: Jinja2 template renderer for Pyramid
  • Maintained by: Rocky Burt
  • Version Control: https://github.com/Pylons/pyramid_jinja2
• pyramid_jqm, scaffolding for developing jQuery Mobile apps with Pyramid.
  • Maintained by: Chris McDonough
  • Version Control: https://github.com/Pylons/pyramid_jqm
• pyramid_layout: Pyramid add-on for managing UI layouts.
  • Maintained by: Chris Rossi, Paul Everitt, Blaise Laflamme
  • Version Control: https://github.com/Pylons/pyramid_layout
• pyramid_ldap, an LDAP authentication policy for Pyramid.
  • Maintained by: Chris McDonough
  • Version Control: https://github.com/Pylons/pyramid_ldap
• pyramid_mailer: a package for the Pyramid framework to take the pain out of sending emails.
  • Maintained by: Dan Jacobs, Chris McDonough
  • Version Control: https://github.com/Pylons/pyramid_mailer
• pyramid_rpc: RPC service add-on for Pyramid, supports XML-RPC in a more extensible manner than pyramid_xmlrpc with support for JSON-RPC and AMF.
  • Maintained by: Michael Merickel, Ben Bangert
  • Version Control: https://github.com/Pylons/pyramid_rpc
• pyramid_tm: Centralized transaction management for Pyramid applications (without middleware).
  • Maintained by: Rocky Burt
  • Version Control: https://github.com/Pylons/pyramid_tm
• pyramid_who: Authentication policy for pyramid using repoze.who 2.0 API.
  • Maintained by: Chris McDonough, Tres Seaver
  • Version Control: https://github.com/Pylons/pyramid_who
• pyramid_xmlrpc: XML-RPC add-on for Pyramid
  • Maintained by: Chris McDonough
  • Version Control: https://github.com/Pylons/pyramid_xmlrpc
• pyramid_zcml: Zope Configuration Markup Language configuration support for Pyramid.
  • Maintained by: Chris McDonough
  • Version Control: https://github.com/Pylons/pyramid_zcml
• pyramid_zodbconn: ZODB Database connection management for Pyramid.
  • Mantained by: Chris McDonough, Chris Rossi
  • Version Control: https://github.com/Pylons/pyramid_zodbconn

Pyramid Development Environment Documentation

Development environments are packages which use Pyramid as a core, but offer alternate services and scaffolding. Each development environment presents a set of opinions and a “personality” to its users. Although users of a development environment can still use all of the services offered by the Pyramid core, they are usually guided to a more focused set of opinions offered by the development environment itself. Development environments often have dependencies beyond those of the Pyramid core.

• Khufu Project: Khufu is an application scaffolding for Pyramid that provides an environment to work with Jinja2 and SQLAlchemy.
  • Maintained by: Rocky Burt
  • Version Control: https://github.com/khufuproject