.. _index:

=================================================
The pyramid Web Application Development Framework
=================================================

:mod:`pyramid` is a small, fast, down-to-earth Python web application
development framework.  It is developed as part of the `Pylons
<http://pylonshq.com>`_ project.  It is licensed under a `BSD-like
license <http://repoze.org/license.html>`_.

Front Matter
============

.. toctree::
   :maxdepth: 1

   copyright.rst
   conventions.rst

Narrative documentation
=======================

Narrative documentation in chapter form explaining how to use
:mod:`pyramid`.

.. toctree::
   :maxdepth: 2

   narr/introduction
   narr/install
   narr/configuration
   narr/firstapp
   narr/project
   narr/startup
   narr/contextfinding
   narr/traversal
   narr/urldispatch
   narr/hybrid
   narr/views
   narr/static
   narr/webob
   narr/templates
   narr/models
   narr/security
   narr/i18n
   narr/vhosting
   narr/events
   narr/environment
   narr/unittesting
   narr/hooks
   narr/extending
   narr/resources
   narr/router
   narr/threadlocals
   narr/zca

Tutorials
=========

Detailed tutorials explaining how to use :mod:`pyramid` to build
various types of applications and how to deploy :mod:`pyramid`
applications to various platforms.

.. toctree::
   :maxdepth: 2

   tutorials/bfg/index.rst
   tutorials/wiki/index.rst
   tutorials/wiki2/index.rst
   tutorials/cmf/index.rst
   tutorials/gae/index.rst
   tutorials/modwsgi/index.rst
   tutorials/zeo/index.rst
   tutorials/zodbsessions/index.rst
   tutorials/catalog/index.rst

Reference Material
==================

Reference material includes API documentation and documentation of
every :mod:`pyramid` :term:`ZCML directive`.

.. toctree::
   :maxdepth: 2

   api
   zcml

Detailed Change History
=======================

.. toctree::
   :maxdepth: 1

   changes

Design Documentation
====================

.. toctree::
   :maxdepth: 1

   designdefense

Sample Applications
===================

.. warning::

   These applications are for an older version of :mod:`pyramid`,
   which was named :mod:`repoze.bfg`.  We'll be updating them soon to
   use :mod:`pyramid`.

`repoze.cluegun <http://svn.repoze.org/repoze.cluegun/trunk/>`_ is a
simple pastebin application based on Rocky Burt's `ClueBin
<http://pypi.python.org/pypi/ClueBin/0.2.3>`_.  It demonstrates form
processing, security, and the use of :term:`ZODB` within a
:mod:`repoze.bfg` application.  It also has very simple
:term:`repoze.who` integration. Check this application out of
Subversion via::

  svn co http://svn.repoze.org/repoze.cluegun/trunk repoze.cluegun

`repoze.virginia <http://svn.repoze.org/repoze.virginia/trunk/>`_ is a
very simple dynamic file rendering application.  It is willing to
render structured text documents, HTML documents, and images from a
filesystem directory.  This application runs the `repoze.org
<http://repoze.org>`_ website.  Check this application out of
Subversion via::

  svn co http://svn.repoze.org/repoze.virginia/trunk repoze.virginia

`repoze.shootout <http://svn.repoze.org/repoze.shootout/trunk/>`_ is
an example "idea competition" application by Carlos de la Guardia.  It
demonstrates a hybrid of :term:`URL dispatch` and :term:`traversal`
and integration with `SQLAlchemy <http://www.sqlalchemy.org/>`_ and
:term:`repoze.who`.  Check this application out of Subversion via::

  svn co http://svn.repoze.org/repoze.shootout/trunk repoze.shootout

`bfgsite <http://svn.repoze.org/bfgsite/trunk>`_ is the software which
runs the `bfg.repoze.org <http://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 <http://karlproject.org>`_ 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
<http://karlproject.org>`_ for download and installation details.

Support and Development
=======================

The `Pyramid web site <http://pylonshq.com/pyramid>`_ is the main
online source of :mod:`pyramid` support and development information.

To report bugs, use the `issue tracker
<http://github.com/Pylons/pyramid/issues>`_.

If you've got questions that aren't answered by this documentation,
contact the `Pylons-discuss maillist
<http://groups.google.com/group/pylons-discuss>`_ or join the `#pylons
IRC channel <irc://irc.freenode.net/#pylons>`_.

Browse and check out tagged and trunk versions of :mod:`pyramid` via
the `Pyramid GitHub repository <http://github.com/Pylons/pyramid/>`_.
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 :mod:`pyramid`, please see
the `contributor's page <http://repoze.org/contributing.html>`_.

Index and Glossary
==================

* :ref:`glossary`
* :ref:`genindex`
* :ref:`search`