.. _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 `_.
It is licensed under a `BSD-like license `_.
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
``_ in a browser, you will see the text
``Hello, world!`` See :ref:`firstapp_chapter` for a full explanation of how
this application works.
.. _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` gives an overview of the major features in Pyramid,
covering a little about a lot.
* :doc:`quick_tutorial/index` is similar to the Quick Tour, but in a tutorial
format, with somewhat deeper treatment of each topic and with working code.
* Like learning by example? Visit the official :ref:`html_tutorials` as well as
the community-contributed :ref:`Pyramid Tutorials
` and :ref:`Pyramid Community Cookbook
`.
* For help getting Pyramid set up, try :ref:`installing_chapter`.
* Need help? See :ref:`Support and Development `.
.. _html_tutorials:
Tutorials
=========
Official 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: 1
tutorials/wiki2/index
tutorials/wiki/index
tutorials/modwsgi/index
.. _support-and-development:
Support and Development
=======================
The `Pyramid website `_ is the main
entry point to :app:`Pyramid` web framework resources for 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-discuss maillist
`_ or join the
`#pyramid 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 either command:
.. code-block:: text
# If you have SSH keys configured on GitHub:
git clone git@github.com:Pylons/pyramid.git
# Otherwise, HTTPS will work, using your GitHub login:
git clone https://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
`_.
.. _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/cookiecutters
narr/scaffolding
narr/upgrading
narr/threadlocals
narr/zca
API Documentation
=================
Comprehensive reference material for every public API exposed by
:app:`Pyramid`:
.. toctree::
:maxdepth: 1
:glob:
api/index
api/*
``p*`` Scripts Documentation
============================
``p*`` scripts included with :app:`Pyramid`.
.. toctree::
:maxdepth: 1
:glob:
pscripts/index
pscripts/*
Change History
==============
.. toctree::
:maxdepth: 1
whatsnew-1.9
whatsnew-1.8
whatsnew-1.7
whatsnew-1.6
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
Copyright, Trademarks, and Attributions
=======================================
.. toctree::
:maxdepth: 1
copyright
Typographical Conventions and Style Guide
=========================================
.. toctree::
:maxdepth: 1
typographical-conventions
Index and Glossary
==================
* :ref:`glossary`
* :ref:`genindex`
* :ref:`search`
.. toctree::
:hidden:
glossary