| | |
| | | .. _index: |
| | | |
| | | =========== |
| | | repoze.bfg |
| | | =========== |
| | | ================================================= |
| | | The Pyramid Web Application Development Framework |
| | | ================================================= |
| | | |
| | | :mod:`repoze.bfg` is a Python web application framework. It is |
| | | inspired by :term:`Zope`, :term:`Pylons`, and :term:`Django`. It uses |
| | | various Zope-related libraries internally to do much of its work. |
| | | :mod:`repoze.bfg` uses the WSGI protocol to handle request and |
| | | responses. |
| | | :app:`Pyramid` is a small, fast, down-to-earth Python web application |
| | | development framework. It is developed as part of the `Pylons Project |
| | | <http://docs.pylonshq.com/>`_. It is licensed under a `BSD-like license |
| | | <http://repoze.org/license.html>`_. |
| | | |
| | | :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>`_. |
| | | .. note:: |
| | | |
| | | "What's New" Documents |
| | | ====================== |
| | | Pyramid is the latest iteration of the web framework previously known as |
| | | :mod:`repoze.bfg`. |
| | | |
| | | Front Matter |
| | | ============ |
| | | |
| | | .. toctree:: |
| | | :maxdepth: 2 |
| | | :maxdepth: 1 |
| | | |
| | | whatsnew-1.1 |
| | | copyright.rst |
| | | conventions.rst |
| | | |
| | | Narrative documentation |
| | | ======================= |
| | | |
| | | Narrative documentation in chapter form explaining how to use |
| | | :mod:`repoze.bfg`. |
| | | :app:`Pyramid`. |
| | | |
| | | .. toctree:: |
| | | :maxdepth: 2 |
| | | |
| | | narr/introduction |
| | | narr/install |
| | | narr/configuration |
| | | narr/firstapp |
| | | narr/project |
| | | narr/startup |
| | | narr/urlmapping |
| | | narr/traversal |
| | | narr/resourcelocation |
| | | narr/urldispatch |
| | | narr/traversal |
| | | narr/views |
| | | narr/webob |
| | | narr/templates |
| | | narr/models |
| | | narr/security |
| | | narr/handlers |
| | | narr/hybrid |
| | | narr/static |
| | | narr/webob |
| | | narr/sessions |
| | | narr/templates |
| | | narr/resources |
| | | narr/security |
| | | narr/i18n |
| | | narr/vhosting |
| | | narr/events |
| | | narr/environment |
| | | narr/unittesting |
| | | narr/testing |
| | | narr/hooks |
| | | narr/declarative |
| | | narr/extending |
| | | narr/resources |
| | | narr/assets |
| | | narr/router |
| | | glossary |
| | | |
| | | API documentation |
| | | ================= |
| | | |
| | | Per-module :mod:`repoze.bfg` API documentation. |
| | | |
| | | .. toctree:: |
| | | :maxdepth: 2 |
| | | |
| | | api/chameleon_text |
| | | api/chameleon_zpt |
| | | api/events |
| | | api/exceptions |
| | | api/location |
| | | api/paster |
| | | api/router |
| | | api/scripting |
| | | api/security |
| | | api/settings |
| | | api/testing |
| | | api/traversal |
| | | api/url |
| | | api/view |
| | | api/wsgi |
| | | narr/threadlocals |
| | | narr/zca |
| | | |
| | | Tutorials |
| | | ========= |
| | | |
| | | ZODB + traversal Wiki tutorial, demonstrating how to build a |
| | | :term:`traversal` based application using :term:`ZODB` and |
| | | :term:`authentication`. Good for people with prior Zope experience |
| | | (or no experience at all). |
| | | Detailed tutorials explaining how to use :app:`Pyramid` to build |
| | | various types of applications and how to deploy :app:`Pyramid` |
| | | applications to various platforms. |
| | | |
| | | .. toctree:: |
| | | :maxdepth: 2 |
| | | |
| | | tutorials/bfgwiki/index.rst |
| | | |
| | | SQLAlchemy + url dispatch Wiki tutorial, demonstrating how to build a |
| | | :term:`url dispatch` based application using :term:`SQLAlchemy` and |
| | | :term:`authentication`. Good for people with prior Pylons experience |
| | | (or no experience at all). |
| | | |
| | | .. toctree:: |
| | | :maxdepth: 2 |
| | | |
| | | tutorials/bfgwiki2/index.rst |
| | | |
| | | :mod:`repoze.bfg` for Zope CMF Developers |
| | | |
| | | .. toctree:: |
| | | :maxdepth: 2 |
| | | |
| | | tutorials/wiki/index.rst |
| | | tutorials/wiki2/index.rst |
| | | tutorials/bfg/index.rst |
| | | tutorials/cmf/index.rst |
| | | |
| | | :mod:`repoze.bfg` on Google's App Engine |
| | | |
| | | .. toctree:: |
| | | :maxdepth: 2 |
| | | |
| | | tutorials/gae/index.rst |
| | | |
| | | :mod:`repoze.bfg` under :term:`mod_wsgi` |
| | | |
| | | .. toctree:: |
| | | :maxdepth: 2 |
| | | |
| | | tutorials/modwsgi/index.rst |
| | | |
| | | Using ZODB's :term:`ZEO` with :mod:`repoze.bfg` |
| | | |
| | | .. toctree:: |
| | | :maxdepth: 2 |
| | | |
| | | tutorials/zeo/index.rst |
| | | tutorials/catalog/index.rst |
| | | |
| | | Using ZODB Sessions in :mod:`repoze.bfg` |
| | | Reference Material |
| | | ================== |
| | | |
| | | Reference material includes API documentation and documentation of |
| | | every :app:`Pyramid` :term:`ZCML directive`. |
| | | |
| | | .. toctree:: |
| | | :maxdepth: 2 |
| | | |
| | | tutorials/zodbsessions/index.rst |
| | | api |
| | | zcml |
| | | |
| | | Detailed Change History |
| | | ======================= |
| | |
| | | Sample Applications |
| | | =================== |
| | | |
| | | `repoze.cluegun <http://svn.repoze.org/repoze.cluegun/trunk/>`_ is a |
| | | simple pastebin application based on Rocky Burt's `ClueBin |
| | | `cluegun <https://github.com/Pylons/cluegun>`_ 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:: |
| | | processing, security, and the use of :term:`ZODB` within a :app:`Pyramid` |
| | | application. Check this application out via: |
| | | |
| | | svn co http://svn.repoze.org/repoze.cluegun/trunk repoze.cluegun |
| | | .. code-block:: text |
| | | |
| | | `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:: |
| | | git clone git://github.com/Pylons/cluegun.git |
| | | |
| | | svn co http://svn.repoze.org/repoze.virginia/trunk repoze.virginia |
| | | `virginia <https://github.com/Pylons/virginia>`_ is a very simple dynamic |
| | | file rendering application. It is willing to render structured text |
| | | documents, HTML documents, and images from a filesystem directory. An |
| | | earlier version of this application runs the `repoze.org |
| | | <http://repoze.org>`_ website. Check this application out via: |
| | | |
| | | `repoze.shootout <http://svn.repoze.org/repoze.shootout/trunk/>`_ is |
| | | an example "idea competition" application by Carlos de la Guardia. It |
| | | demonstrates a hybrid of :term:`URL dispatch` and :term:`traversal` |
| | | and integration with `SQLAlchemy <http://www.sqlalchemy.org/>`_ and |
| | | :term:`repoze.who`. Check this application out of Subversion via:: |
| | | .. code-block:: text |
| | | |
| | | svn co http://svn.repoze.org/repoze.shootout/trunk repoze.shootout |
| | | git clone git://github.com/Pylons/virginia.git |
| | | |
| | | `shootout <https://github.com/Pylons/shootout>`_ is an example "idea |
| | | competition" application by Carlos de la Guardia. It demonstrates a hybrid |
| | | of :term:`URL dispatch` and :term:`traversal` and integration with |
| | | `SQLAlchemy <http://www.sqlalchemy.org/>`_, :term:`repoze.who`, and |
| | | `Deliverance <http://www.deliveranceproject.org/>`_. Check this application |
| | | out of version control via: |
| | | |
| | | .. code-block:: text |
| | | |
| | | git clone git://github.com/Pylons/shootout.git |
| | | |
| | | Older Sample Applications (repoze.bfg) |
| | | ====================================== |
| | | |
| | | .. note:: |
| | | |
| | | These applications are for an older version of :app:`Pyramid`, which was |
| | | named :mod:`repoze.bfg`. They won't work unmodified under Pyramid, but |
| | | might provide useful clues. |
| | | |
| | | `bfgsite <http://svn.repoze.org/bfgsite/trunk>`_ is the software which |
| | | runs the `bfg.repoze.org <http://bfg.repoze.org>`_ website. It |
| | | demonstrates integration with Trac, and includes several |
| | | mini-applications such as a pastebin and tutorial engine. Check a |
| | | buildout for this application out of Subversion via:: |
| | | buildout for this application out of Subversion via: |
| | | |
| | | .. code-block:: text |
| | | |
| | | svn co http://svn.repoze.org/buildouts/bfgsite/ bfgsite_buildout |
| | | |
| | |
| | | Support and Development |
| | | ======================= |
| | | |
| | | The `BFG web site <http://bfg.repoze.org>`_ is the main online source |
| | | of :mod:`repoze.bfg` support and development information. |
| | | The `Pylons Project web site <http://docs.pylonshq.com/>`_ is the main online |
| | | source of :app:`Pyramid` support and development information. |
| | | |
| | | To report bugs, use the `bug tracker <http://bfg.repoze.org/trac>`_. |
| | | To report bugs, use the `issue tracker |
| | | <http://github.com/Pylons/pyramid/issues>`_. |
| | | |
| | | 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>`_. |
| | | contact the `Pylons-devel maillist |
| | | <http://groups.google.com/group/pylons-devel>`_ or join the `#pylons |
| | | IRC channel <irc://irc.freenode.net/#pylons>`_. |
| | | |
| | | 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:: |
| | | Browse and check out tagged and trunk versions of :app:`Pyramid` via |
| | | the `Pyramid GitHub repository <http://github.com/Pylons/pyramid/>`_. |
| | | To check out the trunk via ``git``, use this command: |
| | | |
| | | svn co http://svn.repoze.org/repoze.bfg/trunk repoze.bfg |
| | | .. code-block:: text |
| | | |
| | | To find out how to become a contributor to :mod:`repoze.bfg`, please |
| | | see the `contributor's page <http://repoze.org/contributing.html>`_. |
| | | git clone git@github.com:Pylons/pyramid.git |
| | | |
| | | Indices and tables |
| | | To find out how to become a contributor to :app:`Pyramid`, please see the |
| | | `contributor's section of the documentation |
| | | <http://docs.pylonshq.com/index.html#contributing>`_. |
| | | |
| | | Index and Glossary |
| | | ================== |
| | | |
| | | * :ref:`genindex` |
| | | * :ref:`modindex` |
| | | * :ref:`search` |
| | | * :ref:`glossary` |
| | | |
| | | * :ref:`genindex` |
| | | * :ref:`search` |