1 .. _index: 2 3 .. webapp2 documentation master file, created by 4 sphinx-quickstart on Sat Jul 31 10:41:37 2010. 5 You can adapt this file completely to your liking, but it should at least 6 contain the root `toctree` directive. 7 8 Welcome to webapp2! 9 =================== 10 `webapp2`_ is a lightweight Python web framework compatible with Google App 11 Engine's `webapp`_. 12 13 webapp2 is a `simple`_. it follows the simplicity of webapp, but improves 14 it in some ways: it adds better URI routing and exception handling, a full 15 featured response object and a more flexible dispatching mechanism. 16 17 webapp2 also offers the package :ref:`webapp2_extras <index.api-reference-webapp2-extras>` 18 with several optional utilities: sessions, localization, internationalization, 19 domain and subdomain routing, secure cookies and others. 20 21 webapp2 can also be used outside of Google App Engine, independently of the 22 App Engine SDK. 23 24 For a complete description of how webapp2 improves webapp, see :ref:`features`. 25 26 .. note:: 27 webapp2 is part of the Python 2.7 runtime since App Engine SDK 1.6.0. 28 To include it in your app see 29 `Configuring Libraries <http://code.google.com/appengine/docs/python/python27/using27.html#Configuring_Libraries>`_. 30 31 32 Quick links 33 ----------- 34 - `Downloads <http://code.google.com/p/webapp-improved/downloads/list>`_ 35 - `Google Code Repository <http://code.google.com/p/webapp-improved/>`_ 36 - `Discussion Group <http://groups.google.com/group/webapp2>`_ 37 - `@webapp2 <https://twitter.com/#!/webapp2>`_ 38 39 .. `Samples for Google App Engine <http://code.google.com/p/google-app-engine-samples/>`_: 40 several mini-apps for webapp that serve as examples (they should work with 41 webapp2 too). 42 43 44 Tutorials 45 --------- 46 .. toctree:: 47 :maxdepth: 1 48 49 tutorials/quickstart.rst 50 tutorials/quickstart.nogae.rst 51 tutorials/gettingstarted/index.rst 52 tutorials/i18n.rst 53 54 55 Guide 56 ----- 57 .. toctree:: 58 :maxdepth: 3 59 60 guide/app.rst 61 guide/routing.rst 62 guide/handlers.rst 63 guide/request.rst 64 guide/response.rst 65 guide/exceptions.rst 66 guide/testing.rst 67 guide/extras.rst 68 69 70 API Reference - webapp2 71 ----------------------- 72 .. toctree:: 73 :maxdepth: 2 74 75 api/webapp2.rst 76 77 78 .. _index.api-reference-webapp2-extras: 79 80 API Reference - webapp2_extras 81 ------------------------------ 82 .. toctree:: 83 :maxdepth: 1 84 85 api/webapp2_extras/auth.rst 86 api/webapp2_extras/i18n.rst 87 api/webapp2_extras/jinja2.rst 88 api/webapp2_extras/json.rst 89 api/webapp2_extras/local.rst 90 api/webapp2_extras/mako.rst 91 api/webapp2_extras/routes.rst 92 api/webapp2_extras/securecookie.rst 93 api/webapp2_extras/security.rst 94 api/webapp2_extras/sessions.rst 95 96 97 API Reference - webapp2_extras.appengine 98 ---------------------------------------- 99 Modules that use App Engine libraries and services are restricted to 100 ``webapp2_extras.appengine``. 101 102 .. toctree:: 103 :maxdepth: 1 104 105 api/webapp2_extras/appengine/sessions_memcache.rst 106 api/webapp2_extras/appengine/sessions_ndb.rst 107 api/webapp2_extras/appengine/auth/models.rst 108 api/webapp2_extras/appengine/users.rst 109 110 111 Miscelaneous 112 ------------ 113 .. toctree:: 114 :maxdepth: 1 115 116 features.rst 117 118 119 Indices and tables 120 ------------------ 121 * :ref:`genindex` 122 * :ref:`modindex` 123 * :ref:`search` 124 125 126 .. Old docs linking to new ones or pages we don't want to link. 127 128 .. toctree:: 129 :hidden: 130 131 api/index.rst 132 api/extras.config.rst 133 api/extras.i18n.rst 134 api/extras.jinja2.rst 135 api/extras.json.rst 136 api/extras.local.rst 137 api/extras.local_app.rst 138 api/extras.mako.rst 139 api/extras.routes.rst 140 api/extras.securecookie.rst 141 api/extras.security.rst 142 api/extras.sessions.rst 143 api/extras.sessions_memcache.rst 144 api/extras.sessions_ndb.rst 145 api/extras.users.rst 146 guide/index.rst 147 tutorials/index.rst 148 todo.rst 149 150 151 Requirements 152 ------------ 153 webapp2 is compatible with Python 2.5 and superior. No Python 3 yet. 154 155 `WebOb`_ is the only library required for the core functionality. 156 157 Modules from webapp2_extras may require additional libraries, as indicated in 158 their docs. 159 160 161 Credits 162 ------- 163 webapp2 is a superset of `webapp`_, created by the App Engine team. 164 165 Because webapp2 is intended to be compatible with webapp, the official webapp 166 documentation is valid for webapp2 too. Parts of this documentation were ported 167 from the `App Engine documentation`_, written by the App Engine team and 168 licensed under the Creative Commons Attribution 3.0 License. 169 170 webapp2 has code ported from `Werkzeug`_ and `Tipfy`_. 171 172 webapp2_extras has code ported from Werkzeug, Tipfy and `Tornado Web Server`_. 173 174 The `Sphinx`_ theme mimics the App Engine documentation. 175 176 This library was not created and is not maintained by Google. 177 178 179 Contribute 180 ---------- 181 webapp2 is considered stable, feature complete and well tested, but if you 182 think something is missing or is not working well, please describe it in our 183 issue tracker: 184 185 http://code.google.com/p/webapp-improved/issues/list 186 187 Let us know if you found a bug or if something can be improved. New tutorials 188 and webapp2_extras modules are also welcome, and tests or documentation are 189 never too much. 190 191 Thanks! 192 193 194 License 195 ------- 196 webapp2 is licensed under the `Apache License 2.0`_. 197 198 199 .. _webapp: http://code.google.com/appengine/docs/python/tools/webapp/ 200 .. _webapp2: http://code.google.com/p/webapp-improved/ 201 .. _simple: http://code.google.com/p/webapp-improved/source/browse/webapp2.py 202 .. _WebOb: http://docs.webob.org/ 203 .. _Werkzeug: http://werkzeug.pocoo.org/ 204 .. _Tipfy: http://www.tipfy.org/ 205 .. _Tornado Web Server: http://www.tornadoweb.org/ 206 .. _Sphinx: http://sphinx.pocoo.org/ 207 .. _App Engine documentation: http://code.google.com/appengine/docs/ 208 .. _Apache License 2.0: http://www.apache.org/licenses/LICENSE-2.0 209
