Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 178 lines (130 sloc) 6.323 kb
1ad7722 @bbangert Initial commit.
bbangert authored
1 The Pylons Project Documentation
2 ================================
3
2d3a03d @mcdonc remove stupid link
mcdonc authored
4 The Pylons Project maintains the Pyramid web framework as well as additional
5 packages intended for use with Pyramid. This is the home for the
8ae0cf3 @bbangert Add additional docs and updates.
bbangert authored
6 documentation for all of these projects.
1ad7722 @bbangert Initial commit.
bbangert authored
7
8ae0cf3 @bbangert Add additional docs and updates.
bbangert authored
8 Skip to:
1ad7722 @bbangert Initial commit.
bbangert authored
9
d270147 @blaflamme Changed reference to projects docs
blaflamme authored
10 * `Pyramid documentation </projects/pyramid/dev/>`_
92936a6 @mcdonc bump pdf version numbers
mcdonc authored
11 (`PDF <http://static.repoze.org/pyramid-1.0a9.pdf>`_)
12 (`Epub <http://static.repoze.org/pyramid-1.0a9.epub>`_)
4e751ac @mcdonc prepare for pyramid_zcml and pyramid_handlers releases
mcdonc authored
13
14 * `pyramid_beaker </projects/pyramid_beaker/dev/>`_, beaker session backend
15 plug-in
16
17 * `pyramid_jinja2 </projects/pyramid_jinja2/dev/>`_, `Jinja2
18 <http://jinja.pocoo.org/>`_ template renderer for Pyramid
19
20 * `pyramid_chameleon_genshi </projects/pyramid_chameleon_genshi/dev/>`_,
21 template renderer for `Chameleon's Genshi implementation
d0935a1 @bbangert Update index.
bbangert authored
22 <http://chameleon.repoze.org/docs/latest/genshi.html>`_.
4e751ac @mcdonc prepare for pyramid_zcml and pyramid_handlers releases
mcdonc authored
23
24 * `pyramid_rpc </projects/pyramid_rpc/dev/>`_, RPC service add-on for
25 Pyramid, supports XML-RPC in a more extensible manner than `pyramid_xmlrpc`
26 with planned support for JSON-RPC and AMF.
27
28 * `pyramid_xmlrpc </projects/pyramid_xmlrpc/dev/>`_, XML-RPC add-on for
29 Pyramid
30
31 * `pyramid_handlers </projects/pyramid_handlers/dev/>`_, analogue of
32 Pylons-style "controllers" for Pyramid.
33
34 * `pyramid_zcml </projects/pyramid_zcml/dev/>`_, Zope Configuration Markup
35 Language configuration support for Pyramid.
36
37 Resources (In-Progress)
38 -----------------------
39
40 `The Pyramid Cookbook
41 <http://docs.pylonsproject.org/projects/pyramid_cookbook/dev/>`_ presents
42 topical, practical usages of Pyramid. Unfinished.
43
44 `Pyramid Tutorials
45 <http://docs.pylonsproject.org/projects/pyramid_tutorials/dev/>`_ presents
46 tutorials dealing with Pyramid integrations with other technologies. Very
47 unfinished.
5854365 @mcdonc reorder index page (FAQ higher), some wording tweaks, rejigger note a…
mcdonc authored
48
49 Support
50 -------
1ad7722 @bbangert Initial commit.
bbangert authored
51
8ae0cf3 @bbangert Add additional docs and updates.
bbangert authored
52 Development questions related to Pylons projects can be discussed on the
5854365 @mcdonc reorder index page (FAQ higher), some wording tweaks, rejigger note a…
mcdonc authored
53 `pylons-devel mail list <http://groups.google.com/group/pylons-devel/>`_.
8ae0cf3 @bbangert Add additional docs and updates.
bbangert authored
54
55 On IRC, Pylons developers are generally available on the ``#pylons`` channel
56 on the `Freenode IRC Network <http://freenode.net/>`_.
57
5854365 @mcdonc reorder index page (FAQ higher), some wording tweaks, rejigger note a…
mcdonc authored
58 .. topic:: Using Support Wisely
8ae0cf3 @bbangert Add additional docs and updates.
bbangert authored
59
5854365 @mcdonc reorder index page (FAQ higher), some wording tweaks, rejigger note a…
mcdonc authored
60 Before asking a technical question on the maillist(s) or in IRC, please
61 make sure to try the following things (paraphrased from `Before You Ask
62 <http://www.catb.org/~esr/faqs/smart-questions.html#before>`_):
8ae0cf3 @bbangert Add additional docs and updates.
bbangert authored
63
5854365 @mcdonc reorder index page (FAQ higher), some wording tweaks, rejigger note a…
mcdonc authored
64 - Try to find an answer by reading the manual.
8ae0cf3 @bbangert Add additional docs and updates.
bbangert authored
65
5854365 @mcdonc reorder index page (FAQ higher), some wording tweaks, rejigger note a…
mcdonc authored
66 - Try to find an answer by searching the maillist archives.
8ae0cf3 @bbangert Add additional docs and updates.
bbangert authored
67
5854365 @mcdonc reorder index page (FAQ higher), some wording tweaks, rejigger note a…
mcdonc authored
68 - Try to find an answer by searching the Web.
69
70 - Try to find an answer by inspection or experimentation.
71
72 - If you're a programmer, try to find an answer by reading the source
73 code.
74
75 After exhausing these avenues, it's completely appropriate to ask a
76 question on the Pylons-devel maillist or #pylons IRC channel. When you
77 ask your question, please describe what you've learned from the efforts
78 above, as it will help the developers focus on answering your question
79 quickly. It also helps tremendously if you are able to provide a code or
80 configuration snippet that makes the problem easily repeatable.
8ae0cf3 @bbangert Add additional docs and updates.
bbangert authored
81
82 FAQ
83 ---
84
5854365 @mcdonc reorder index page (FAQ higher), some wording tweaks, rejigger note a…
mcdonc authored
85 For Pylons users coming from Pylons 1 or repoze.bfg the change to a new core
86 package might raise some questions regarding how to proceed, what it means
87 for existing applications.
aaa7c03 @mcdonc move top text
mcdonc authored
88
0647fd7 @mcdonc add faqs
mcdonc authored
89 .. toctree::
90
91 faq/pylonsproject
92 faq/pyramid
93
5854365 @mcdonc reorder index page (FAQ higher), some wording tweaks, rejigger note a…
mcdonc authored
94 Contributing
95 ------------
96
97 The Pylons Project welcomes contributors. Please read the following
98 documentation about how the Pylons Project functions, coding styles expected
99 for contributions, and the community standards we expect everyone to abide
100 by.
0647fd7 @mcdonc add faqs
mcdonc authored
101
5854365 @mcdonc reorder index page (FAQ higher), some wording tweaks, rejigger note a…
mcdonc authored
102 .. toctree::
103 :maxdepth: 2
104
105 community/conduct
0d61f02 @mcdonc add contributing document
mcdonc authored
106 community/contributing
5854365 @mcdonc reorder index page (FAQ higher), some wording tweaks, rejigger note a…
mcdonc authored
107 community/codestyle
6a32e0f @bbangert Add testing guidelines.
bbangert authored
108 community/testing
5854365 @mcdonc reorder index page (FAQ higher), some wording tweaks, rejigger note a…
mcdonc authored
109 community/featuresbugs
8ae0cf3 @bbangert Add additional docs and updates.
bbangert authored
110
18f874a @mcdonc add podcasts
mcdonc authored
111 Podcasts
112 --------
113
114 Subscribe to the Pylons Podcasts. Pylons Podcasts are a series of audio
115 podcasts from developers of the Pylons Project. You can either subscribe in
116 iTunes or Rhythmbox (or your favorite audio client) using the Feed URL below,
117 or listen to individual podcasts.
118
119 `Feed URL (RSS/iTunes) <http://static.repoze.org/casts/pylons.xml>`_
120
121 Episode 1: Q&A with Ben and Chris
122 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
123
124 `MP3 (length: 1:26:08, ~ 43MB)
3eba4a8 @mcdonc get url right
mcdonc authored
125 <http://static.repoze.org/casts/pylonspodcast-1-2010-12-03.mp3>`_
18f874a @mcdonc add podcasts
mcdonc authored
126
127 In our inaugural episode, Chris McDonough and Ben Bangert talk about `Pyramid
7205676 @blaflamme Changed references from pylonshq.com to pylonsproject.org
blaflamme authored
128 <http://docs.pylonsproject.org/projects/pyramid/dev/index.html>`_, `pyramid_deform
18f874a @mcdonc add podcasts
mcdonc authored
129 <https://github.com/Pylons/pyramid_deform>`_, `zc.buildout (aka "buildout")
130 <http://www.buildout.org/>`_, `Fabric <http://docs.fabfile.org/>`_, `WebError
131 <http://turbogears.org/2.0/docs/modules/thirdparty/weberror.html>`_,
132 `repoze.profile <http://docs.repoze.org/profile/>`_, `Paste's errorcatcher
133 <http://pythonpaste.org/modules/exceptions.html#paste.exceptions.errormiddleware.ErrorMiddleware>`_,
134 `Arecibo <http://pypi.python.org/pypi/arecibo>`_, `repoze.debug
135 <http://docs.repoze.org/debug/>`_, `Chris Davies' Pylons-to-Pyramid porting
136 guide <http://cd34.com/blog/framework/pylons-1-0-to-pyramid-1-0a1/>`_,
137 `Cucumber <http://cukes.info/>`_, `Freshen
138 <https://github.com/rlisagor/freshen>`_, `FormEncode
139 <http://formencode.org/>`_, `Formish <http://ish.io>`_, `Deform
140 <http://docs.repoze.org/deform/>`_, `ZODB <http://zodb.org>`_, `repoze.folder
141 <http://docs.repoze.org/folder>`_, `repoze.catalog
142 <http://docs.repoze.org/catalog>`_, `#pylons IRC channel
143 <irc://freenode.net#pylons>`_, `Paste <http://pythonpaste.org>`_, `mod_wsgi
144 <http://code.google.com/p/modwsgi/>`_, `uwsgi
145 <http://projects.unbit.it/uwsgi/>`_, `repoze.workflow
146 <http://docs.repoze.org/workflow/>`_, `Colander
147 <http://docs.repoze.org/colander/>`_, `repoze.tm2
148 <http://docs.repoze.org/tm2/>`_, `pyramid_routehelper
149 <https://github.com/Pylons/pyramid_routehelper>`_, `pyramid_beaker
150 <https://github.com/Pylons/pyramid_beaker>`_, `the Pyramid todo list
151 <https://github.com/Pylons/pyramid/blob/master/TODO.txt>`_, `zope.sqlalchemy
152 <http://pypi.python.org/pypi/zope.sqlalchemy>`_, and the zope `transaction
153 <http://pypi.python.org/pypi/transaction/1.1.1>`_ module.
154
f2f0999 @blaflamme Added Promote section with logo and badges
blaflamme authored
155 Promote
156 -------
157
158 If you want to promote The Pylons Project and it's related technologies or your
159 own work made with our tools.
160
161 .. toctree::
162 :maxdepth: 2
163
164 promote/logos
165 promote/badges
00da310 @blaflamme Added 1st desktop
blaflamme authored
166 promote/desktops
f2f0999 @blaflamme Added Promote section with logo and badges
blaflamme authored
167
8ae0cf3 @bbangert Add additional docs and updates.
bbangert authored
168 Denials
169 -------
170
171 Don't worry, none of these are actually true. We swear!
172
173 .. toctree::
174 :maxdepth: 2
175
176 denials/pyramid
f2f0999 @blaflamme Added Promote section with logo and badges
blaflamme authored
177
Something went wrong with that request. Please try again.