RedHatTraining/pyramid.git

			@@ -1,13 +1,18 @@
			.. _index:

			=================================================
			The pyramid Web Application Development Framework
			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>`_.
			:app:`Pyramid` is a small, fast, down-to-earth Python web application
			development framework. It is developed as part of the `Pylons Project
			<http://docs.pylonshq.com/>`_. It is licensed under a `BSD-like license
			<http://repoze.org/license.html>`_.

			.. note::

			Pyramid is the latest iteration of the web framework previously known as
			:mod:`repoze.bfg`.

			Front Matter
			============
			@@ -22,7 +27,7 @@
			=======================

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

			.. toctree::
			:maxdepth: 2
			@@ -33,26 +38,27 @@
			narr/firstapp
			narr/project
			narr/startup
			narr/contextfinding
			narr/traversal
			narr/resourcelocation
			narr/urldispatch
			narr/hybrid
			narr/traversal
			narr/views
			narr/handlers
			narr/hybrid
			narr/static
			narr/webob
			narr/sessions
			narr/templates
			narr/models
			narr/resources
			narr/security
			narr/i18n
			narr/vhosting
			narr/events
			narr/environment
			narr/unittesting
			narr/testing
			narr/hooks
			narr/declarative
			narr/extending
			narr/resources
			narr/assets
			narr/router
			narr/threadlocals
			narr/zca
			@@ -60,28 +66,27 @@
			Tutorials
			=========

			Detailed tutorials explaining how to use :mod:`pyramid` to build
			various types of applications and how to deploy :mod:`pyramid`
			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/bfg/index.rst
			tutorials/wiki/index.rst
			tutorials/wiki2/index.rst
			tutorials/bfg/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`.
			every :app:`Pyramid` :term:`ZCML directive`.

			.. toctree::
			:maxdepth: 2
			@@ -108,44 +113,53 @@
			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
			`cluegun <https://github.com/Pylons/cluegun>`_ 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::
			processing, security, and the use of :term:`ZODB` within a :app:`Pyramid`
			application. Check this application out via:

			svn co http://svn.repoze.org/repoze.cluegun/trunk repoze.cluegun
			.. code-block:: text

			`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::
			git clone git://github.com/Pylons/cluegun.git

			svn co http://svn.repoze.org/repoze.virginia/trunk repoze.virginia
			`virginia <https://github.com/Pylons/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
			<http://repoze.org>`_ website. Check this application out via:

			`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::
			.. code-block:: text

			svn co http://svn.repoze.org/repoze.shootout/trunk repoze.shootout
			git clone git://github.com/Pylons/virginia.git

			`shootout <https://github.com/Pylons/shootout>`_ 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/>`_, :term:`repoze.who`, and
			`Deliverance <http://www.deliveranceproject.org/>`_. Check this application
			out of version control via:

			.. code-block:: text

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

			Older Sample Applications (repoze.bfg)
			======================================

			.. 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 <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::
			buildout for this application out of Subversion via:

			.. code-block:: text

			svn co http://svn.repoze.org/buildouts/bfgsite/ bfgsite_buildout

			@@ -160,8 +174,8 @@
			Support and Development
			=======================

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

			To report bugs, use the `issue tracker
			<http://github.com/Pylons/pyramid/issues>`_.
			@@ -171,14 +185,17 @@
			<http://groups.google.com/group/pylons-devel>`_ or join the `#pylons
			IRC channel <irc://irc.freenode.net/#pylons>`_.

			Browse and check out tagged and trunk versions of :mod:`pyramid` via
			Browse and check out tagged and trunk versions of :app:`Pyramid` via
			the `Pyramid GitHub repository <http://github.com/Pylons/pyramid/>`_.
			To check out the trunk via ``git``, use this command::
			To check out the trunk via ``git``, use this command:

			.. code-block:: text

			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>`_.
			To find out how to become a contributor to :app:`Pyramid`, please see the
			`contributor's section of the documentation
			<http://docs.pylonshq.com/index.html#contributing>`_.

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