| commit | author | age | ||
| 9974be | 1 | .. _index: |
| f70c23 | 2 | |
| edd915 | 3 | ================================================= |
| ee2945 | 4 | The Pyramid Web Application Development Framework |
| edd915 | 5 | ================================================= |
| f70c23 | 6 | |
| fd5ae9 | 7 | :app:`Pyramid` is a small, fast, down-to-earth Python web application |
| a3a27a | 8 | development framework. It is developed as part of the `Pylons Project |
| CM | 9 | <http://docs.pylonshq.com/>`_. It is licensed under a `BSD-like license |
| 10 | <http://repoze.org/license.html>`_. | |
| 11 | ||
| 12 | .. note:: | |
| 13 | ||
| 14 | Pyramid is the latest iteration of the web framework previously known as | |
| 15 | :mod:`repoze.bfg`. | |
| 878328 | 16 | |
| de449d | 17 | Front Matter |
| CM | 18 | ============ |
| 878328 | 19 | |
| CM | 20 | .. toctree:: |
| 21 | :maxdepth: 1 | |
| 22 | ||
| 23 | copyright.rst | |
| 24 | conventions.rst | |
| 0797f0 | 25 | |
| 9e3bdb | 26 | Narrative documentation |
| e99f7a | 27 | ======================= |
| 9e3bdb | 28 | |
| CM | 29 | Narrative documentation in chapter form explaining how to use |
| fd5ae9 | 30 | :app:`Pyramid`. |
| f70c23 | 31 | |
| CM | 32 | .. toctree:: |
| 9e3bdb | 33 | :maxdepth: 2 |
| f70c23 | 34 | |
| 9e3bdb | 35 | narr/introduction |
| 102d19 | 36 | narr/install |
| 41e3bf | 37 | narr/configuration |
| 9ec2d6 | 38 | narr/firstapp |
| 54f2bb | 39 | narr/project |
| c6e58b | 40 | narr/startup |
| 780999 | 41 | narr/resourcelocation |
| c5f24b | 42 | narr/urldispatch |
| 36cbf3 | 43 | narr/traversal |
| d6798e | 44 | narr/views |
| 28d963 | 45 | narr/handlers |
| 4762ab | 46 | narr/hybrid |
| 590fe7 | 47 | narr/static |
| 888d65 | 48 | narr/webob |
| 04ebd5 | 49 | narr/sessions |
| 9cafa3 | 50 | narr/templates |
| fb6a5c | 51 | narr/resources |
| 1462bc | 52 | narr/security |
| 7534ba | 53 | narr/i18n |
| e62e47 | 54 | narr/vhosting |
| e17c8d | 55 | narr/events |
| 47b4d3 | 56 | narr/environment |
| 6ee49a | 57 | narr/testing |
| c8cf22 | 58 | narr/hooks |
| c7c40b | 59 | narr/declarative |
| e6855b | 60 | narr/extending |
| fb6a5c | 61 | narr/assets |
| 03b756 | 62 | narr/router |
| 538344 | 63 | narr/threadlocals |
| 37bcb7 | 64 | narr/zca |
| 8fd58c | 65 | |
| 9d68f9 | 66 | Tutorials |
| CM | 67 | ========= |
| 68 | ||
| fd5ae9 | 69 | Detailed tutorials explaining how to use :app:`Pyramid` to build |
| CM | 70 | various types of applications and how to deploy :app:`Pyramid` |
| 878328 | 71 | applications to various platforms. |
| 841dcf | 72 | |
| CM | 73 | .. toctree:: |
| 6638cf | 74 | :maxdepth: 2 |
| 841dcf | 75 | |
| edd915 | 76 | tutorials/wiki/index.rst |
| CM | 77 | tutorials/wiki2/index.rst |
| f1b2cd | 78 | tutorials/bfg/index.rst |
| 9d68f9 | 79 | tutorials/cmf/index.rst |
| 5810ad | 80 | tutorials/gae/index.rst |
| 9c5a10 | 81 | tutorials/modwsgi/index.rst |
| 7a1f7a | 82 | tutorials/zeo/index.rst |
| 593251 | 83 | tutorials/catalog/index.rst |
| e2c34f | 84 | |
| 04bee5 | 85 | Reference Material |
| CM | 86 | ================== |
| 87 | ||
| 88 | Reference material includes API documentation and documentation of | |
| fd5ae9 | 89 | every :app:`Pyramid` :term:`ZCML directive`. |
| 04bee5 | 90 | |
| CM | 91 | .. toctree:: |
| 92 | :maxdepth: 2 | |
| 93 | ||
| 94 | api | |
| 95 | zcml | |
| 96 | ||
| a53cbf | 97 | Detailed Change History |
| CM | 98 | ======================= |
| 9d68f9 | 99 | |
| CM | 100 | .. toctree:: |
| 841dcf | 101 | :maxdepth: 1 |
| 9d68f9 | 102 | |
| CM | 103 | changes |
| 104 | ||
| fbfea7 | 105 | Design Documentation |
| CM | 106 | ==================== |
| 107 | ||
| 108 | .. toctree:: | |
| 6b0315 | 109 | :maxdepth: 1 |
| fbfea7 | 110 | |
| CM | 111 | designdefense |
| 112 | ||
| e99f7a | 113 | Sample Applications |
| CM | 114 | =================== |
| edd915 | 115 | |
| 2197ff | 116 | `cluegun <https://github.com/Pylons/cluegun>`_ is a simple pastebin |
| CM | 117 | application based on Rocky Burt's `ClueBin |
| e99f7a | 118 | <http://pypi.python.org/pypi/ClueBin/0.2.3>`_. It demonstrates form |
| 124238 | 119 | processing, security, and the use of :term:`ZODB` within a :app:`Pyramid` |
| 8c8697 | 120 | application. Check this application out via: |
| CM | 121 | |
| 122 | .. code-block:: text | |
| e99f7a | 123 | |
| 2197ff | 124 | git clone git://github.com/Pylons/cluegun.git |
| e99f7a | 125 | |
| 2197ff | 126 | `virginia <https://github.com/Pylons/virginia>`_ is a very simple dynamic |
| CM | 127 | file rendering application. It is willing to render structured text |
| 128 | documents, HTML documents, and images from a filesystem directory. An | |
| 129 | earlier version of this application runs the `repoze.org | |
| 8c8697 | 130 | <http://repoze.org>`_ website. Check this application out via: |
| CM | 131 | |
| 132 | .. code-block:: text | |
| e99f7a | 133 | |
| 2197ff | 134 | git clone git://github.com/Pylons/virginia.git |
| e99f7a | 135 | |
| 2197ff | 136 | `shootout <https://github.com/Pylons/shootout>`_ is an example "idea |
| CM | 137 | competition" application by Carlos de la Guardia. It demonstrates a hybrid |
| 138 | of :term:`URL dispatch` and :term:`traversal` and integration with | |
| b37e96 | 139 | `SQLAlchemy <http://www.sqlalchemy.org/>`_, :term:`repoze.who`, and |
| CM | 140 | `Deliverance <http://www.deliveranceproject.org/>`_. Check this application |
| 8c8697 | 141 | out of version control via: |
| CM | 142 | |
| 143 | .. code-block:: text | |
| 9e1f15 | 144 | |
| 2197ff | 145 | git clone git://github.com/Pylons/shootout.git |
| CM | 146 | |
| 147 | Older Sample Applications (repoze.bfg) | |
| 148 | ====================================== | |
| 149 | ||
| 150 | .. note:: | |
| 151 | ||
| 152 | These applications are for an older version of :app:`Pyramid`, which was | |
| 153 | named :mod:`repoze.bfg`. They won't work unmodified under Pyramid, but | |
| 154 | might provide useful clues. | |
| 9e1f15 | 155 | |
| a864bd | 156 | `bfgsite <http://svn.repoze.org/bfgsite/trunk>`_ is the software which |
| aca8a7 | 157 | runs the `bfg.repoze.org <http://bfg.repoze.org>`_ website. It |
| a864bd | 158 | demonstrates integration with Trac, and includes several |
| CM | 159 | mini-applications such as a pastebin and tutorial engine. Check a |
| 8c8697 | 160 | buildout for this application out of Subversion via: |
| CM | 161 | |
| 162 | .. code-block:: text | |
| a864bd | 163 | |
| CM | 164 | svn co http://svn.repoze.org/buildouts/bfgsite/ bfgsite_buildout |
| 165 | ||
| 166 | `KARL <http://karlproject.org>`_ is a moderately-sized application | |
| af17cc | 167 | (roughly 70K lines of Python code) built on top of :mod:`repoze.bfg` |
| f30488 | 168 | and other Repoze software. It is an open source web system for |
| CM | 169 | collaboration, organizational intranets, and knowledge management, It |
| 406572 | 170 | provides facilities for wikis, calendars, manuals, searching, tagging, |
| CM | 171 | commenting, and file uploads. See the `KARL site |
| f30488 | 172 | <http://karlproject.org>`_ for download and installation details. |
| a864bd | 173 | |
| 0797f0 | 174 | Support and Development |
| CM | 175 | ======================= |
| 176 | ||
| a3a27a | 177 | The `Pylons Project web site <http://docs.pylonshq.com/>`_ is the main online |
| fd5ae9 | 178 | source of :app:`Pyramid` support and development information. |
| 1dad96 | 179 | |
| edd915 | 180 | To report bugs, use the `issue tracker |
| CM | 181 | <http://github.com/Pylons/pyramid/issues>`_. |
| 0797f0 | 182 | |
| CM | 183 | If you've got questions that aren't answered by this documentation, |
| a6a402 | 184 | contact the `Pylons-devel maillist |
| CM | 185 | <http://groups.google.com/group/pylons-devel>`_ or join the `#pylons |
| edd915 | 186 | IRC channel <irc://irc.freenode.net/#pylons>`_. |
| 0797f0 | 187 | |
| fd5ae9 | 188 | Browse and check out tagged and trunk versions of :app:`Pyramid` via |
| edd915 | 189 | the `Pyramid GitHub repository <http://github.com/Pylons/pyramid/>`_. |
| 8c8697 | 190 | To check out the trunk via ``git``, use this command: |
| CM | 191 | |
| 192 | .. code-block:: text | |
| 0797f0 | 193 | |
| edd915 | 194 | git clone git@github.com:Pylons/pyramid.git |
| 0797f0 | 195 | |
| ee5fb2 | 196 | To find out how to become a contributor to :app:`Pyramid`, please see the |
| CM | 197 | `contributor's section of the documentation |
| 198 | <http://docs.pylonshq.com/index.html#contributing>`_. | |
| 0797f0 | 199 | |
| 878328 | 200 | Index and Glossary |
| f70c23 | 201 | ================== |
| CM | 202 | |
| 1b8f7a | 203 | * :ref:`glossary` |
| 878328 | 204 | * :ref:`genindex` |
| CM | 205 | * :ref:`search` |
