1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
|
.. _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.
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
* :doc:`quick_tour` goes through the major features in Pyramid, covering
a little about a lot.
* 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
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/bfg/index.rst
tutorials/modwsgi/index.rst
.. _html_api_documentation:
API Documentation
=================
Comprehensive reference material for every public API exposed by :app:`Pyramid`:
.. toctree::
:maxdepth: 1
:glob:
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
|
