:app:`Pyramid` is a small, fast, down-to-earth Python web application development framework. It is developed as part of the Pylons Project. It is licensed under a BSD-like license.
.. toctree:: :maxdepth: 1 copyright.rst conventions.rst
.. toctree:: :maxdepth: 1 whatsnew-1.1 whatsnew-1.0
Narrative documentation in chapter form explaining how to use :app:`Pyramid`.
.. toctree:: :maxdepth: 2 narr/introduction narr/install narr/configuration narr/firstapp narr/project narr/startup narr/urldispatch narr/views narr/renderers narr/templates narr/viewconfig narr/assets narr/webob narr/sessions narr/events narr/environment narr/logging narr/commandline narr/i18n narr/vhosting narr/testing narr/resources narr/muchadoabouttraversal narr/traversal narr/security narr/hybrid narr/hooks narr/advconfig narr/extending narr/router narr/threadlocals narr/zca
Detailed tutorials explaining how to use :app:`Pyramid` to build various types of applications and how to deploy :app:`Pyramid` applications to various platforms.
.. toctree:: :maxdepth: 2 tutorials/wiki2/index.rst tutorials/wiki/index.rst tutorials/bfg/index.rst tutorials/gae/index.rst tutorials/modwsgi/index.rst
Reference material includes documentation for every :app:`Pyramid` API.
.. toctree:: :maxdepth: 2 api
.. toctree:: :maxdepth: 1 changes
.. toctree:: :maxdepth: 1 designdefense
cluegun is a simple pastebin application based on Rocky Burt's ClueBin. It demonstrates form processing, security, and the use of :term:`ZODB` within a :app:`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. 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 :term:`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
Note
These applications are for an older version of :app:`Pyramid`, which was named :mod:`repoze.bfg`. They won't work unmodified under Pyramid, but might provide useful clues.
bfgsite is the software which runs the bfg.repoze.org website. It demonstrates integration with Trac, and includes several mini-applications such as a pastebin and tutorial engine. Check a buildout for this application out of Subversion via:
svn co http://svn.repoze.org/buildouts/bfgsite/ bfgsite_buildout
KARL is a moderately-sized application (roughly 70K lines of Python code) built on top of :mod:`repoze.bfg` and other Repoze software. 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.
The Pylons Project web site is the main online source of :app:`Pyramid` support and development information.
To report bugs, use the issue tracker.
If you've got questions that aren't answered by this documentation, contact the Pylons-devel maillist or join the #pylons IRC channel.
Browse and check out tagged and trunk versions of :app:`Pyramid` via
the Pyramid GitHub repository.
To check out the trunk via git, use this command:
git clone [email protected]:Pylons/pyramid.git
To find out how to become a contributor to :app:`Pyramid`, please see the contributor's section of the documentation.