Skip to content

Latest commit

 

History

History
203 lines (150 loc) · 5.26 KB

index.rst

File metadata and controls

203 lines (150 loc) · 5.26 KB
Raw

The Pyramid Web Application Development Framework

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.

Front Matter

copyright.rst conventions.rst

"What's New" Documents

whatsnew-1.0 whatsnew-1.1

Narrative documentation

Narrative documentation in chapter form explaining how to use Pyramid.

narr/introduction narr/install narr/configuration narr/firstapp narr/project narr/startup narr/urldispatch narr/muchadoabouttraversal narr/traversal narr/views narr/renderers narr/templates narr/viewconfig narr/resources narr/assets narr/webob narr/sessions narr/security narr/hybrid narr/i18n narr/vhosting narr/events narr/environment narr/testing narr/hooks narr/advconfig narr/extending narr/router narr/threadlocals narr/zca

Tutorials

Detailed tutorials explaining how to use Pyramid to build various types of applications and how to deploy Pyramid applications to various platforms.

tutorials/wiki2/index.rst tutorials/wiki/index.rst tutorials/bfg/index.rst tutorials/gae/index.rst tutorials/modwsgi/index.rst

Reference Material

Reference material includes documentation for every Pyramid API.

api

Detailed Change History

changes

Design Documentation

designdefense

Sample Applications

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

Older Sample Applications (repoze.bfg)

Note

These applications are for an older version of Pyramid, which was named 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 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.

Support and Development

The Pylons Project web site is the main online source of 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 Pyramid via the Pyramid GitHub repository. To check out the trunk via git, use this command:

git clone git@github.com:Pylons/pyramid.git

To find out how to become a contributor to Pyramid, please see the contributor's section of the documentation.

Index and Glossary

  • glossary
  • genindex
  • search