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 cookbooks

Previous versions

Pyramid Add-On Documentation

Supported Add-Ons

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

Unsupported Add-Ons

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

Sample Applications


These applications run only on Python 2.x, and so do some of their dependencies.

cluegun is a simple pastebin application based on Rocky Burt’s ClueBin. It demonstrates form processing, security, and the use of ZODB within a Pyramid application. Check this application out via:

git clone git://github.com/Pylons/cluegun.git

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. It’s also a good example of traversal. An earlier version of this application runs the repoze.org website. Check this application out via:

git clone git://github.com/Pylons/virginia.git

shootout is 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. Check this application out of version control via:

git clone git://github.com/Pylons/shootout.git

KARL is 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.

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