Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 150 lines (110 sloc) 5.057 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
f92e7d7 @mcdonc factor out pyramid docs vs. library docs
mcdonc authored
8 Documentation Index
9 -------------------
792b7fd @mcdonc Add libs.
mcdonc authored
10
f92e7d7 @mcdonc factor out pyramid docs vs. library docs
mcdonc authored
11 Documentation sources for subprojects within the Pylons Project are listed
12 below.
4e751ac @mcdonc prepare for pyramid_zcml and pyramid_handlers releases
mcdonc authored
13
f92e7d7 @mcdonc factor out pyramid docs vs. library docs
mcdonc authored
14 .. toctree::
15 :maxdepth: 2
4e751ac @mcdonc prepare for pyramid_zcml and pyramid_handlers releases
mcdonc authored
16
f92e7d7 @mcdonc factor out pyramid docs vs. library docs
mcdonc authored
17 docs/pyramid
dd570cb @mcdonc add a section for pylons:
mcdonc authored
18 docs/pylons
f92e7d7 @mcdonc factor out pyramid docs vs. library docs
mcdonc authored
19 docs/libraries
5854365 @mcdonc reorder index page (FAQ higher), some wording tweaks, rejigger note a…
mcdonc authored
20
21 Support
22 -------
1ad7722 @bbangert Initial commit.
bbangert authored
23
8ae0cf3 @bbangert Add additional docs and updates.
bbangert authored
24 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
25 `pylons-devel mail list <http://groups.google.com/group/pylons-devel/>`_.
8ae0cf3 @bbangert Add additional docs and updates.
bbangert authored
26
27 On IRC, Pylons developers are generally available on the ``#pylons`` channel
28 on the `Freenode IRC Network <http://freenode.net/>`_.
29
5854365 @mcdonc reorder index page (FAQ higher), some wording tweaks, rejigger note a…
mcdonc authored
30 .. topic:: Using Support Wisely
8ae0cf3 @bbangert Add additional docs and updates.
bbangert authored
31
5854365 @mcdonc reorder index page (FAQ higher), some wording tweaks, rejigger note a…
mcdonc authored
32 Before asking a technical question on the maillist(s) or in IRC, please
33 make sure to try the following things (paraphrased from `Before You Ask
34 <http://www.catb.org/~esr/faqs/smart-questions.html#before>`_):
8ae0cf3 @bbangert Add additional docs and updates.
bbangert authored
35
5854365 @mcdonc reorder index page (FAQ higher), some wording tweaks, rejigger note a…
mcdonc authored
36 - Try to find an answer by reading the manual.
8ae0cf3 @bbangert Add additional docs and updates.
bbangert authored
37
5854365 @mcdonc reorder index page (FAQ higher), some wording tweaks, rejigger note a…
mcdonc authored
38 - Try to find an answer by searching the maillist archives.
8ae0cf3 @bbangert Add additional docs and updates.
bbangert authored
39
5854365 @mcdonc reorder index page (FAQ higher), some wording tweaks, rejigger note a…
mcdonc authored
40 - Try to find an answer by searching the Web.
41
42 - Try to find an answer by inspection or experimentation.
43
44 - If you're a programmer, try to find an answer by reading the source
45 code.
46
47 After exhausing these avenues, it's completely appropriate to ask a
48 question on the Pylons-devel maillist or #pylons IRC channel. When you
49 ask your question, please describe what you've learned from the efforts
50 above, as it will help the developers focus on answering your question
51 quickly. It also helps tremendously if you are able to provide a code or
52 configuration snippet that makes the problem easily repeatable.
8ae0cf3 @bbangert Add additional docs and updates.
bbangert authored
53
54 FAQ
55 ---
56
5854365 @mcdonc reorder index page (FAQ higher), some wording tweaks, rejigger note a…
mcdonc authored
57 For Pylons users coming from Pylons 1 or repoze.bfg the change to a new core
58 package might raise some questions regarding how to proceed, what it means
59 for existing applications.
aaa7c03 @mcdonc move top text
mcdonc authored
60
0647fd7 @mcdonc add faqs
mcdonc authored
61 .. toctree::
62
63 faq/pylonsproject
64 faq/pyramid
65
5854365 @mcdonc reorder index page (FAQ higher), some wording tweaks, rejigger note a…
mcdonc authored
66 Contributing
67 ------------
68
69 The Pylons Project welcomes contributors. Please read the following
70 documentation about how the Pylons Project functions, coding styles expected
71 for contributions, and the community standards we expect everyone to abide
72 by.
0647fd7 @mcdonc add faqs
mcdonc authored
73
5854365 @mcdonc reorder index page (FAQ higher), some wording tweaks, rejigger note a…
mcdonc authored
74 .. toctree::
75 :maxdepth: 2
76
77 community/conduct
0d61f02 @mcdonc add contributing document
mcdonc authored
78 community/contributing
5854365 @mcdonc reorder index page (FAQ higher), some wording tweaks, rejigger note a…
mcdonc authored
79 community/codestyle
6a32e0f @bbangert Add testing guidelines.
bbangert authored
80 community/testing
5854365 @mcdonc reorder index page (FAQ higher), some wording tweaks, rejigger note a…
mcdonc authored
81 community/featuresbugs
8ae0cf3 @bbangert Add additional docs and updates.
bbangert authored
82
18f874a @mcdonc add podcasts
mcdonc authored
83 Podcasts
84 --------
85
86 Subscribe to the Pylons Podcasts. Pylons Podcasts are a series of audio
87 podcasts from developers of the Pylons Project. You can either subscribe in
88 iTunes or Rhythmbox (or your favorite audio client) using the Feed URL below,
89 or listen to individual podcasts.
90
91 `Feed URL (RSS/iTunes) <http://static.repoze.org/casts/pylons.xml>`_
92
93 Episode 1: Q&A with Ben and Chris
94 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
95
96 `MP3 (length: 1:26:08, ~ 43MB)
3eba4a8 @mcdonc get url right
mcdonc authored
97 <http://static.repoze.org/casts/pylonspodcast-1-2010-12-03.mp3>`_
18f874a @mcdonc add podcasts
mcdonc authored
98
99 In our inaugural episode, Chris McDonough and Ben Bangert talk about `Pyramid
7205676 @blaflamme Changed references from pylonshq.com to pylonsproject.org
blaflamme authored
100 <http://docs.pylonsproject.org/projects/pyramid/dev/index.html>`_, `pyramid_deform
18f874a @mcdonc add podcasts
mcdonc authored
101 <https://github.com/Pylons/pyramid_deform>`_, `zc.buildout (aka "buildout")
102 <http://www.buildout.org/>`_, `Fabric <http://docs.fabfile.org/>`_, `WebError
103 <http://turbogears.org/2.0/docs/modules/thirdparty/weberror.html>`_,
104 `repoze.profile <http://docs.repoze.org/profile/>`_, `Paste's errorcatcher
105 <http://pythonpaste.org/modules/exceptions.html#paste.exceptions.errormiddleware.ErrorMiddleware>`_,
106 `Arecibo <http://pypi.python.org/pypi/arecibo>`_, `repoze.debug
107 <http://docs.repoze.org/debug/>`_, `Chris Davies' Pylons-to-Pyramid porting
108 guide <http://cd34.com/blog/framework/pylons-1-0-to-pyramid-1-0a1/>`_,
109 `Cucumber <http://cukes.info/>`_, `Freshen
110 <https://github.com/rlisagor/freshen>`_, `FormEncode
111 <http://formencode.org/>`_, `Formish <http://ish.io>`_, `Deform
112 <http://docs.repoze.org/deform/>`_, `ZODB <http://zodb.org>`_, `repoze.folder
113 <http://docs.repoze.org/folder>`_, `repoze.catalog
114 <http://docs.repoze.org/catalog>`_, `#pylons IRC channel
115 <irc://freenode.net#pylons>`_, `Paste <http://pythonpaste.org>`_, `mod_wsgi
116 <http://code.google.com/p/modwsgi/>`_, `uwsgi
117 <http://projects.unbit.it/uwsgi/>`_, `repoze.workflow
118 <http://docs.repoze.org/workflow/>`_, `Colander
119 <http://docs.repoze.org/colander/>`_, `repoze.tm2
120 <http://docs.repoze.org/tm2/>`_, `pyramid_routehelper
121 <https://github.com/Pylons/pyramid_routehelper>`_, `pyramid_beaker
122 <https://github.com/Pylons/pyramid_beaker>`_, `the Pyramid todo list
123 <https://github.com/Pylons/pyramid/blob/master/TODO.txt>`_, `zope.sqlalchemy
124 <http://pypi.python.org/pypi/zope.sqlalchemy>`_, and the zope `transaction
125 <http://pypi.python.org/pypi/transaction/1.1.1>`_ module.
126
f2f0999 @blaflamme Added Promote section with logo and badges
blaflamme authored
127 Promote
128 -------
129
130 If you want to promote The Pylons Project and it's related technologies or your
131 own work made with our tools.
132
133 .. toctree::
134 :maxdepth: 2
135
136 promote/logos
137 promote/badges
00da310 @blaflamme Added 1st desktop
blaflamme authored
138 promote/desktops
f2f0999 @blaflamme Added Promote section with logo and badges
blaflamme authored
139
8ae0cf3 @bbangert Add additional docs and updates.
bbangert authored
140 Denials
141 -------
142
143 Don't worry, none of these are actually true. We swear!
144
145 .. toctree::
146 :maxdepth: 2
147
148 denials/pyramid
f2f0999 @blaflamme Added Promote section with logo and badges
blaflamme authored
149
Something went wrong with that request. Please try again.