-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
220 lines (212 loc) · 10.7 KB
/
index.html
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
208
209
210
211
212
213
214
215
216
217
218
219
220
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>pyroutes — pyroutes v0.4.1 documentation</title>
<link rel="stylesheet" href="static/pyroutes.css" type="text/css" />
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '0.4.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="static/jquery.js"></script>
<script type="text/javascript" src="static/underscore.js"></script>
<script type="text/javascript" src="static/doctools.js"></script>
<link rel="top" title="pyroutes v0.4.1 documentation" href="#" />
<link rel="next" title="Installation" href="installation.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="installation.html" title="Installation"
accesskey="N">next</a> |</li>
<li><a href="#">pyroutes v0.4.1 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="pyroutes">
<h1>pyroutes<a class="headerlink" href="#pyroutes" title="Permalink to this headline">¶</a></h1>
<p>pyroutes is a really small framework (more of a wrapper really) around wsgi for
developing small python web apps.</p>
<p>If you’re developing a larger project, I suggest you point your browser to <a class="reference external" href="http://djangoproject.com">http://djangoproject.com</a> instead :-)</p>
</div>
<div class="section" id="user-manual">
<h1>User manual<a class="headerlink" href="#user-manual" title="Permalink to this headline">¶</a></h1>
<p>Contents:</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="installation.html#installation-with-pip">Installation with pip</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#installation-with-easy-install">Installation with easy_install</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#following-the-development">Following the development</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="usage.html">Let’s do it! (aka Quickstart)</a><ul>
<li class="toctree-l2"><a class="reference internal" href="usage.html#application-entry-point">Application entry point</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#adding-routes">Adding routes</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#starting-the-development-server">Starting the development server</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#firing-it-up">Firing it up</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#debugging">Debugging</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#using-urls-as-data">Using URLs as data</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#accessing-request-data">Accessing request data</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#sending-responses-to-the-user">Sending responses to the user</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#c-is-for-cookie">C is for cookie..</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#let-s-go-templates">Let’s go templates!</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="deployment.html">Deployment</a><ul>
<li class="toctree-l2"><a class="reference internal" href="deployment.html#apache2-2-and-mod-wsgi">Apache2.2 and mod_wsgi</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="middleware.html">Middleware</a><ul>
<li class="toctree-l2"><a class="reference internal" href="middleware.html#adding-middleware">Adding middleware</a></li>
<li class="toctree-l2"><a class="reference internal" href="middleware.html#creating-your-own">Creating your own</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="reference-documentation">
<h1>Reference documentation<a class="headerlink" href="#reference-documentation" title="Permalink to this headline">¶</a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="reference/pyroutes.html">Route handling</a></li>
<li class="toctree-l1"><a class="reference internal" href="reference/response.html">Request and response objects</a><ul>
<li class="toctree-l2"><a class="reference internal" href="reference/response.html#overview">Overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/response.html#request-objects">Request objects</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/response.html#response-objects">Response objects</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/response.html#redirect-objects">Redirect objects</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference/response.html#httpexception-objects">HttpException objects</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="reference/template.html">Templates</a></li>
<li class="toctree-l1"><a class="reference internal" href="reference/utils.html">Utilities</a></li>
<li class="toctree-l1"><a class="reference internal" href="reference/settings.html">Settings</a></li>
</ul>
</div>
</div>
<div class="section" id="appendices">
<h1>Appendices<a class="headerlink" href="#appendices" title="Permalink to this headline">¶</a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="appendix/xmltemplate.html">Introduction to XML::Template</a></li>
</ul>
</div>
</div>
<div class="section" id="release-change-logs">
<h1>Release change logs<a class="headerlink" href="#release-change-logs" title="Permalink to this headline">¶</a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#release-0-4-1">Release 0.4.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#release-0-4-0">Release 0.4.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#release-0-3-1">Release 0.3.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#release-0-3-0">Release 0.3.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#release-0-2-2">Release 0.2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#release-0-2-1">Release 0.2.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#release-0-2-0">Release 0.2.0</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="contributing">
<h1>Contributing<a class="headerlink" href="#contributing" title="Permalink to this headline">¶</a></h1>
<p>The source code is version controlled using git and resides on <a class="reference external" href="http://github.com/pyroutes/pyroutes">http://github.com/pyroutes/pyroutes</a>. Feel free to clone it
and fix stuff :-) Just remember to check if the test-suite still passes. I will not pull in features if they don’t include
documentation, unittest or simply breaks the existing tests. Bugfixes to the tests are always welcome too though.</p>
<p>For the tests to run, you will need some extra packages. Names are by
debian/ubuntu package name.</p>
<blockquote>
<ul class="simple">
<li>python-coverage</li>
<li>python-nose</li>
</ul>
</blockquote>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="#">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">pyroutes</a></li>
<li><a class="reference internal" href="#user-manual">User manual</a><ul>
</ul>
</li>
<li><a class="reference internal" href="#reference-documentation">Reference documentation</a><ul>
</ul>
</li>
<li><a class="reference internal" href="#appendices">Appendices</a><ul>
</ul>
</li>
<li><a class="reference internal" href="#release-change-logs">Release change logs</a><ul>
</ul>
</li>
<li><a class="reference internal" href="#contributing">Contributing</a></li>
</ul>
<h4>Next topic</h4>
<p class="topless"><a href="installation.html"
title="next chapter">Installation</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="sources/index.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="installation.html" title="Installation"
>next</a> |</li>
<li><a href="#">pyroutes v0.4.1 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2009-2010, Kristian Klette.
Last updated on Apr 17, 2011.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.1.
</div>
</body>
</html>