| commit | author | age | ||
| 9974be | 1 | .. _index: |
| f70c23 | 2 | |
| a66e00 | 3 | ========================= |
| 83fefb | 4 | The Pyramid Web Framework |
| a66e00 | 5 | ========================= |
| f70c23 | 6 | |
| 8bb97b | 7 | :app:`Pyramid` is a small, fast, down-to-earth Python web framework. It is |
| 80ce00 | 8 | developed as part of the `Pylons Project <https://pylonsproject.org>`_. |
| 8bb97b | 9 | It is licensed under a `BSD-like license <http://repoze.org/license.html>`_. |
| a3a27a | 10 | |
| d4bbb6 | 11 | Here is one of the simplest :app:`Pyramid` applications you can make: |
| d36b56 | 12 | |
| a98c01 | 13 | .. literalinclude:: narr/helloworld.py |
| d36b56 | 14 | |
| db9468 | 15 | After you install :app:`Pyramid` and run this application, when you visit |
| 4b84f6 | 16 | `<http://localhost:6543/>`_ in a browser, you will see the text |
| SP | 17 | ``Hello World!`` See :ref:`firstapp_chapter` for a full explanation of how |
| 8bb97b | 18 | this application works. |
| e17da6 | 19 | |
| 0797f0 | 20 | |
| 933773 | 21 | .. _getting_started: |
| 47eaa1 | 22 | |
| PE | 23 | Getting Started |
| 24 | =============== | |
| 25 | ||
| 8bb97b | 26 | If you are new to Pyramid, we have a few resources that can help you get up to |
| SP | 27 | speed right away. |
| 71b83e | 28 | |
| 47eaa1 | 29 | .. toctree:: |
| 5b47ba | 30 | :hidden: |
| 47eaa1 | 31 | |
| ae9014 | 32 | quick_tour |
| b1b922 | 33 | quick_tutorial/index |
| ae9014 | 34 | |
| 8bb97b | 35 | * :doc:`quick_tour` gives an overview of the major features in Pyramid, |
| SP | 36 | covering a little about a lot. |
| ae9014 | 37 | |
| 8bb97b | 38 | * Like learning by example? Visit the official :ref:`html_tutorials` as well as |
| 8a80b1 | 39 | the community-contributed :ref:`Pyramid Tutorials |
| 34515f | 40 | <tutorials:pyramid-tutorials>` and :ref:`Pyramid Community Cookbook |
| 8a80b1 | 41 | <cookbook:pyramid-cookbook>`. |
| ae9014 | 42 | |
| 8bb97b | 43 | * For help getting Pyramid set up, try :ref:`installing_chapter`. |
| ae9014 | 44 | |
| 8bb97b | 45 | * Need help? See :ref:`Support and Development <support-and-development>`. |
| ae9014 | 46 | |
| 8bb97b | 47 | |
| SP | 48 | .. _html_tutorials: |
| 49 | ||
| 50 | Tutorials | |
| 51 | ========= | |
| 52 | ||
| 9f5f84 | 53 | Official tutorials provide a quick overview of :app:`Pyramid`'s features in more depth than the Quick Tour and with working code, explain how to use :app:`Pyramid` to build various types of applications, and how to deploy :app:`Pyramid` applications to various platforms. |
| 8bb97b | 54 | |
| SP | 55 | .. toctree:: |
| 56 | :maxdepth: 1 | |
| 57 | ||
| 9f5f84 | 58 | quick_tutorial/index |
| 933773 | 59 | tutorials/wiki2/index |
| SP | 60 | tutorials/wiki/index |
| 61 | tutorials/modwsgi/index | |
| 8bb97b | 62 | |
| SP | 63 | |
| 64 | .. _support-and-development: | |
| 65 | ||
| 66 | Support and Development | |
| 67 | ======================= | |
| 68 | ||
| 029625 | 69 | The `Pyramid website <https://trypyramid.com/documentation.html>`_ is the main |
| dcb5d6 | 70 | entry point to :app:`Pyramid` web framework resources for support and |
| SP | 71 | development information. |
| 8bb97b | 72 | |
| SP | 73 | To report bugs, use the `issue tracker |
| 74 | <https://github.com/Pylons/pyramid/issues>`_. | |
| 75 | ||
| 76 | If you've got questions that aren't answered by this documentation, contact the | |
| 1cb30e | 77 | `Pylons-discuss maillist |
| SP | 78 | <https://groups.google.com/forum/#!forum/pylons-discuss>`_ or join the |
| 79 | `#pyramid IRC channel | |
| a1aa71 | 80 | <https://webchat.freenode.net/?channels=pyramid>`_. |
| 8bb97b | 81 | |
| SP | 82 | Browse and check out tagged and trunk versions of :app:`Pyramid` via the |
| 83 | `Pyramid GitHub repository <https://github.com/Pylons/pyramid/>`_. To check out | |
| 28bfdf | 84 | the trunk via ``git``, use either command: |
| 8bb97b | 85 | |
| SP | 86 | .. code-block:: text |
| 87 | ||
| 93dd77 | 88 | # If you have SSH keys configured on GitHub: |
| SP | 89 | git clone git@github.com:Pylons/pyramid.git |
| 90 | ||
| 91 | # Otherwise, HTTPS will work, using your GitHub login: | |
| 92 | git clone https://github.com/Pylons/pyramid.git | |
| 8bb97b | 93 | |
| c21612 | 94 | To find out how to become a contributor to :app:`Pyramid`, please see `How to Contribute Source Code and Documentation <https://pylonsproject.org/community-how-to-contribute.html>`_. |
| ae9014 | 95 | |
| 47eaa1 | 96 | |
| 55860e | 97 | .. _html_narrative_documentation: |
| d36b56 | 98 | |
| a70d54 | 99 | Narrative Documentation |
| e99f7a | 100 | ======================= |
| 9e3bdb | 101 | |
| 8bb97b | 102 | Narrative documentation in chapter form explaining how to use :app:`Pyramid`. |
| f70c23 | 103 | |
| CM | 104 | .. toctree:: |
| 9e3bdb | 105 | :maxdepth: 2 |
| f70c23 | 106 | |
| 9e3bdb | 107 | narr/introduction |
| 102d19 | 108 | narr/install |
| 9ec2d6 | 109 | narr/firstapp |
| e17da6 | 110 | narr/configuration |
| 54f2bb | 111 | narr/project |
| c6e58b | 112 | narr/startup |
| c4503b | 113 | narr/router |
| c5f24b | 114 | narr/urldispatch |
| d6798e | 115 | narr/views |
| a59c78 | 116 | narr/renderers |
| 8271f7 | 117 | narr/templates |
| 8a1b50 | 118 | narr/viewconfig |
| 88b9ee | 119 | narr/assets |
| 888d65 | 120 | narr/webob |
| 04ebd5 | 121 | narr/sessions |
| e17c8d | 122 | narr/events |
| 47b4d3 | 123 | narr/environment |
| 1ae7af | 124 | narr/logging |
| 3d338e | 125 | narr/paste |
| ae4c57 | 126 | narr/commandline |
| 8cb682 | 127 | narr/i18n |
| CM | 128 | narr/vhosting |
| 6ee49a | 129 | narr/testing |
| 8cb682 | 130 | narr/resources |
| 97b64d | 131 | narr/hellotraversal |
| 8cb682 | 132 | narr/muchadoabouttraversal |
| CM | 133 | narr/traversal |
| 134 | narr/security | |
| 135 | narr/hybrid | |
| 37d2c2 | 136 | narr/subrequest |
| c8cf22 | 137 | narr/hooks |
| 9d97b6 | 138 | narr/introspector |
| e6855b | 139 | narr/extending |
| c4503b | 140 | narr/advconfig |
| CM | 141 | narr/extconfig |
| 6261ae | 142 | narr/cookiecutters |
| bfd4b3 | 143 | narr/scaffolding |
| b72ba1 | 144 | narr/upgrading |
| 538344 | 145 | narr/threadlocals |
| 37bcb7 | 146 | narr/zca |
| 8fd58c | 147 | |
| e2c34f | 148 | |
| aebd2f | 149 | API Documentation |
| a70d54 | 150 | ================= |
| 04bee5 | 151 | |
| 8bb97b | 152 | Comprehensive reference material for every public API exposed by |
| SP | 153 | :app:`Pyramid`: |
| 04bee5 | 154 | |
| CM | 155 | .. toctree:: |
| 9279d7 | 156 | :maxdepth: 1 |
| TL | 157 | :glob: |
| 04bee5 | 158 | |
| cac212 | 159 | api/index |
| 9279d7 | 160 | api/* |
| 8bb97b | 161 | |
| 04bee5 | 162 | |
| 5ff3d2 | 163 | ``p*`` Scripts Documentation |
| SP | 164 | ============================ |
| 165 | ||
| 3a3250 | 166 | ``p*`` scripts included with :app:`Pyramid`. |
| 5ff3d2 | 167 | |
| SP | 168 | .. toctree:: |
| 169 | :maxdepth: 1 | |
| 170 | :glob: | |
| 171 | ||
| 172 | pscripts/index | |
| 173 | pscripts/* | |
| 174 | ||
| 175 | ||
| aebd2f | 176 | Change History |
| CM | 177 | ============== |
| 9d68f9 | 178 | |
| CM | 179 | .. toctree:: |
| 841dcf | 180 | :maxdepth: 1 |
| 9d68f9 | 181 | |
| 7b024b | 182 | whatsnew-1.10 |
| 2b9b6c | 183 | whatsnew-1.9 |
| 9edad5 | 184 | whatsnew-1.8 |
| 311482 | 185 | whatsnew-1.7 |
| bfe000 | 186 | whatsnew-1.6 |
| a66e00 | 187 | whatsnew-1.5 |
| 49d634 | 188 | whatsnew-1.4 |
| PE | 189 | whatsnew-1.3 |
| 190 | whatsnew-1.2 | |
| 191 | whatsnew-1.1 | |
| 192 | whatsnew-1.0 | |
| 9d68f9 | 193 | changes |
| CM | 194 | |
| 8bb97b | 195 | |
| aebd2f | 196 | Design Documents |
| CM | 197 | ================ |
| fbfea7 | 198 | |
| CM | 199 | .. toctree:: |
| 6b0315 | 200 | :maxdepth: 1 |
| fbfea7 | 201 | |
| CM | 202 | designdefense |
| a864bd | 203 | |
| 71b83e | 204 | |
| 8bb97b | 205 | Copyright, Trademarks, and Attributions |
| SP | 206 | ======================================= |
| 0797f0 | 207 | |
| 8bb97b | 208 | .. toctree:: |
| SP | 209 | :maxdepth: 1 |
| 1dad96 | 210 | |
| 8bb97b | 211 | copyright |
| 0797f0 | 212 | |
| CM | 213 | |
| b99ada | 214 | Typographical Conventions and Style Guide |
| SP | 215 | ========================================= |
| 8c8697 | 216 | |
| 8bb97b | 217 | .. toctree:: |
| SP | 218 | :maxdepth: 1 |
| 0797f0 | 219 | |
| b99ada | 220 | typographical-conventions |
| 0797f0 | 221 | |
| CM | 222 | |
| 878328 | 223 | Index and Glossary |
| f70c23 | 224 | ================== |
| CM | 225 | |
| 1b8f7a | 226 | * :ref:`glossary` |
| 878328 | 227 | * :ref:`genindex` |
| CM | 228 | * :ref:`search` |
| 012b97 | 229 | |
| M | 230 | |
| 231 | .. toctree:: | |
| 232 | :hidden: | |
| 233 | ||
| 234 | glossary | |
| 235 | ||
