.. _index:
|
|
=========================
|
The Pyramid Web Framework
|
=========================
|
|
:app:`Pyramid` is a small, fast, down-to-earth Python web framework. It
|
is developed as part of the `Pylons Project
|
<http://docs.pylonsproject.org/>`_. It is licensed under a `BSD-like license
|
<http://repoze.org/license.html>`_.
|
|
Here is one of the simplest :app:`Pyramid` applications you can make:
|
|
.. literalinclude:: narr/helloworld.py
|
|
After you install :app:`Pyramid` and run this application, when you visit
|
`<http://localhost:8080/hello/world>`_ in a browser, you will see the text
|
``Hello, world!``
|
|
See :ref:`firstapp_chapter` for a full explanation of how this application
|
works. Read the :ref:`html_narrative_documentation` to understand how
|
:app:`Pyramid` is designed to scale from simple applications like this to
|
very large web applications. To just dive in headfirst, read the
|
:doc:`quick_tour`.
|
|
Front Matter
|
============
|
|
.. toctree::
|
:maxdepth: 1
|
|
copyright.rst
|
conventions.rst
|
|
.. _html_getting_started:
|
|
Getting Started
|
===============
|
|
If you are new to Pyramid, we have a few resources that can help you get
|
up to speed right away.
|
|
.. toctree::
|
:hidden:
|
|
quick_tour
|
quick_tutorial/index
|
|
* :doc:`quick_tour` goes through the major features in Pyramid, covering
|
a little about a lot.
|
|
* :doc:`quick_tutorial/index` does the same, but in a tutorial format:
|
deeper treatment of each topic and with working code.
|
|
* To see a minimal Pyramid web application, check out
|
:ref:`firstapp_chapter`.
|
|
* For help getting Pyramid set up, try
|
:ref:`installing_chapter`.
|
|
* Like learning by example? Visit the official
|
:doc:`wiki tutorial <../tutorials/wiki2/index>` as well as the
|
community-contributed
|
:ref:`Pyramid tutorials <tutorials:pyramid-tutorials>`, which include
|
a :ref:`single file tasks tutorial <tutorials:single-file-tutorial>`.
|
|
* Need help? See :ref:`Support and
|
Development <support-and-development>`.
|
|
|
.. _html_narrative_documentation:
|
|
Narrative Documentation
|
=======================
|
|
Narrative documentation in chapter form explaining how to use
|
:app:`Pyramid`.
|
|
.. toctree::
|
:maxdepth: 2
|
|
narr/introduction
|
narr/install
|
narr/firstapp
|
narr/configuration
|
narr/project
|
narr/startup
|
narr/router
|
narr/urldispatch
|
narr/views
|
narr/renderers
|
narr/templates
|
narr/viewconfig
|
narr/assets
|
narr/webob
|
narr/sessions
|
narr/events
|
narr/environment
|
narr/logging
|
narr/paste
|
narr/commandline
|
narr/i18n
|
narr/vhosting
|
narr/testing
|
narr/resources
|
narr/hellotraversal
|
narr/muchadoabouttraversal
|
narr/traversal
|
narr/security
|
narr/hybrid
|
narr/subrequest
|
narr/hooks
|
narr/introspector
|
narr/extending
|
narr/advconfig
|
narr/extconfig
|
narr/scaffolding
|
narr/upgrading
|
narr/threadlocals
|
narr/zca
|
|
.. _html_tutorials:
|
|
Tutorials
|
=========
|
|
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/modwsgi/index.rst
|
|
API Documentation
|
=================
|
|
Comprehensive reference material for every public API exposed by :app:`Pyramid`:
|
|
.. toctree::
|
:maxdepth: 1
|
:glob:
|
|
api/index
|
api/*
|
|
Change History
|
==============
|
|
.. toctree::
|
:maxdepth: 1
|
|
whatsnew-1.5
|
whatsnew-1.4
|
whatsnew-1.3
|
whatsnew-1.2
|
whatsnew-1.1
|
whatsnew-1.0
|
changes
|
|
Design Documents
|
================
|
|
.. toctree::
|
:maxdepth: 1
|
|
designdefense
|
|
.. _support-and-development:
|
|
Support and Development
|
=======================
|
|
The `Pylons Project web site <http://pylonsproject.org/>`_ is the main online
|
source of :app:`Pyramid` support and development information.
|
|
To report bugs, use the `issue tracker
|
<https://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 `#pyramid
|
IRC channel <irc://irc.freenode.net/#pyramid>`_.
|
|
Browse and check out tagged and trunk versions of :app:`Pyramid` via
|
the `Pyramid GitHub repository <https://github.com/Pylons/pyramid/>`_.
|
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 :app:`Pyramid`, please see the
|
`contributor's section of the documentation
|
<http://docs.pylonsproject.org/en/latest/#contributing>`_.
|
|
Index and Glossary
|
==================
|
|
* :ref:`glossary`
|
* :ref:`genindex`
|
* :ref:`search`
|
|
|
.. toctree::
|
:hidden:
|
|
glossary
|
