blob: 8c0660246acde652f77afa5dc8324e4576deb699 (
plain)
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
|
.. _index:
===========
repoze.bfg
===========
:mod:`repoze.bfg` is a Python web application framework. It is
inspired by Zope's publisher, though it is less ambitious in scope.
It relies heavily on :term:`Zope` libraries and :term:`WSGI`.
:mod:`repoze.bfg` is developed as part of the `Repoze
<http://repoze.org>`_ project by `Agendaless Consulting
<http://agendaless.com>`_ and other contributors. It is licensed
under a `BSD-like license <http://repoze.org/license.html>`_.
Narrative documentation
=======================
Narrative documentation in chapter form explaining how to use
:mod:`repoze.bfg`.
.. toctree::
:maxdepth: 2
narr/introduction
narr/install
narr/project
narr/startup
narr/urlmapping
narr/traversal
narr/urldispatch
narr/views
narr/templates
narr/models
narr/security
narr/events
changes
glossary
Tutorials
=========
Step-by-step tutorials which demonstrate how you might use
:mod:`repoze.bfg`.
``lxmlgraph`` Tutorial
.. toctree::
:maxdepth: 3
tutorials/lxmlgraph/index.rst
:mod:`repoze.bfg` for Zope CMF Developers
.. toctree::
:maxdepth: 3
tutorials/cmf/index.rst
API documentation
=================
Per-module :mod:`repoze.bfg` API documentation.
.. toctree::
:maxdepth: 2
api/events
api/push
api/router
api/security
api/template
api/traversal
api/urldispatch
api/view
api/wsgi
Sample Applications
===================
`repoze.wiki <http://svn.repoze.org/repoze.wiki/trunk/>`_ is a port of
the `TurboGears 20-Minute Wiki
<http://turbogears.org/2.0/docs/main/Wiki20/wiki20.html>`_. It
demonstrates integration with `SQLAlchemy
<http://www.sqlalchemy.org/>`_, customized traversal, and form
processing. Check this application out of Subversion via::
svn co http://svn.repoze.org/repoze.wiki/trunk repoze.wiki
`repoze.cluegun <http://svn.repoze.org/repoze.cluegun/trunk/>`_ is a
simple pastebin application based on Rocky Burt's `ClueBin
<http://pypi.python.org/pypi/ClueBin/0.2.3>`_. It demonstrates form
processing, security, and the use of :term:`ZODB` within a
:mod:`repoze.bfg` application. It also has very simple
:term:`repoze.who` integration. Check this application out of
Subversion via::
svn co http://svn.repoze.org/repoze.cluegun/trunk repoze.cluegun
`repoze.virginia <http://svn.repoze.org/repoze.virginia/trunk/>`_ is a
very simple dynamic file rendering application. It is willing to
render structured text documents, HTML documents, and images from a
filesystem directory. This application runs the `repoze.org
<http://repoze.org>`_ website. Check this application out of
Subversion via::
svn co http://svn.repoze.org/repoze.virginia/trunk repoze.virginia
`repoze.shootout <http://svn.repoze.org/repoze.shootout/trunk/>`_ is
an example "idea competition" application by Carlos de la Guardia. It
demonstrates :term:`URL dispatch` and integration with `SQLAlchemy
<http://www.sqlalchemy.org/>`_ and :term:`repoze.who`. Check this
application out of Subversion via::
svn co http://svn.repoze.org/repoze.shootout/trunk repoze.shootout
Support and Development
=======================
To report bugs, use the `Repoze bug tracker <http://bugs.repoze.org>`_.
If you've got questions that aren't answered by this documentation,
contact the `Repoze-dev maillist
<http://lists.repoze.org/listinfo/repoze-dev>`_ or join the `#repoze
IRC channel <irc://irc.freenode.net/#repoze>`_.
Browse and check out tagged and trunk versions of :mod:`repoze.bfg`
via the `Repoze Subversion repository
<http://http://svn.repoze.org/repoze.bfg/>`_. To check out the trunk
via Subversion, use this command::
svn co http://svn.repoze.org/repoze.bfg/trunk repoze.bfg
To find out how to become a contributor to :mod:`repoze.bfg`, please
see the `contributor's page <http://repoze.org/contributing.html>`_.
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
* :ref:`glossary`
|
