Edit me on GitHub

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:

Main Documentation

Stable branch : version 1.5 (latest)

Development branch : upcoming 1.6 (master)

Tutorials and Cookbook Recipes

  • A list of all official and community-contributed Pyramid Tutorials. You may submit your tutorial for inclusion by submitting a pull request through the pyramid_tutorials repository.
  • The Pyramid Cookbook presents topical, practical uses of Pyramid. The Pyramid Cookbook is not a source of official Pyramid documentation, but is a collection of contributions from the community. You may submit your Pyramid recipes for inclusion in the Cookbook through the pyramid_cookbook repository.

Previous versions

Pyramid Add-ons

Supported Add-ons

Pyramid supports extensibility through add-ons. The following add-ons are officially endorsed by the Pylons Project. Documentation for each add-on is hosted at its respective name under the Pylons Project.

Unsupported Add-Ons

These are libraries which used to be officially supported by the Pylons Project, but have since become unsupported.

Sample Pyramid Applications

cluegun

A simple pastebin application based on Rocky Burt’s ClueBin. It demonstrates form processing, security, and the use of ZODB within a Pyramid application.

KARL
A moderately-sized application (roughly 80K lines of Python code) built on top of Pyramid. It is an open source web system for collaboration, organizational intranets, and knowledge management. It provides facilities for wikis, calendars, manuals, searching, tagging, commenting, and file uploads. See the KARL site for download and installation details.
shootout

An example “idea competition” application by Carlos de la Guardia and Lukasz Fidosz. It demonstrates URL dispatch, simple authentication, integration with SQLAlchemy and pyramid_simpleform.

virginia

A very simple dynamic file rendering application. It is willing to render structured text documents, HTML documents, and images from a filesystem directory. It’s also a good example of traversal. An earlier version of this application runs the repoze.org website.

Sample Pyramid Development Environments

“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.

Akhet
A Pyramid library and demo application with a Pylons-like feel. Its most known for its former application scaffold, which helped users transition from Pylons and those preferring a more Pylons-like API. The scaffold has been retired but the demo plays a similar role.
Khufu Project

Khufu is an application scaffolding for Pyramid that provides an environment to work with Jinja2 and SQLAlchemy.

Kotti

Kotti is a high-level, Pythonic web application framework. It includes an extensible Content Management System called the Kotti CMS, offering all the features you would expect from a modern CMS.

Ptah

Ptah is a fast, fun, open source high-level Python web development environment.

Substance-D

An application server built upon the Pyramid web framework. It provides a user interface for managing content as well as libraries and utilities which make it easy to create applications.

Ziggurat

A bundled application framework for data driven Pyramid project development.