summaryrefslogtreecommitdiff
path: root/docs/index.rst
AgeCommit message (Collapse)Author
2009-05-27Merge authchanges branch to trunk.Chris McDonough
2009-05-22Lysdexia.Chris McDonough
2009-05-22DRY.Chris McDonough
2009-05-22Note how moderate.Chris McDonough
2009-05-22Mention BFGSITE and Karl.Chris McDonough
2009-05-22Cleanup.Chris McDonough
2009-05-16This feature was removed.Chris McDonough
2009-05-03Add GAE tutorial plus make CHANGES.txt renderings work.Chris McDonough
2009-05-01Merge "c-free" branch to trunk.Chris McDonough
2009-01-27FeaturesChris McDonough
-------- - The ``repoze.bfg.url.model_url`` API now works against contexts derived from Routes URL dispatch (``Routes.util.url_for`` is called under the hood). - "Virtual root" support for traversal-based applications has been added. Virtual root support is useful when you'd like to host some model in a :mod:`repoze.bfg` model graph as an application under a URL pathname that does not include the model path itself. For more information, see the (new) "Virtual Hosting" chapter in the documentation. - A ``repoze.bfg.traversal.virtual_root`` API has been added. When called, it returns the virtual root object (or the physical root object if no virtual root has been specified). Implementation Changes ---------------------- - ``repoze.bfg.traversal.RoutesModelTraverser`` has been moved to ``repoze.bfg.urldispatch``. - ``model_url`` URL generation is now performed via an adapter lookup based on the context and the request. - ZCML which registers two adapters for the ``IContextURL`` interface has been added to the configure.zcml in ``repoze.bfg.includes``.
2009-01-17Up to date.Chris McDonough
2009-01-15- Instead of invariably using ``webob.Request`` as the "requestChris McDonough
factory" (e.g. in the ``Router`` class) and ``webob.Response`` and the "response factory" (e.g. in ``render_template_to_response``), allow both to be overridden via a ZCML utility hook. See the "Using ZCML Hooks" chapter of the documentation for more information.
2009-01-12- An interface specific to the HTTP verb (GET/PUT/POST/DELETE/HEAD) isChris McDonough
attached to each request object on ingress. The HTTP-verb-related interfaces are defined in ``repoze.bfg.interfaces`` and are ``IGETRequest``, ``IPOSTRequest``, ``IPUTRequest``, ``IDELETERequest`` and ``IHEADRequest``. These interfaces can be specified as the ``request_type`` attribute of a bfg view declaration. A view naming a specific HTTP-verb-matching interface will be found only if the view is defined with a request_type that matches the HTTP verb in the incoming request. The more general ``IRequest`` interface can be used as the request_type to catch all requests (and this is indeed the default). All requests implement ``IRequest``. The HTTP-verb-matching idea was pioneered by `repoze.bfg.restrequest <http://pypi.python.org/pypi/repoze.bfg.restrequest/1.0.1>`_ . That package is no longer required, but still functions fine.
2009-01-07Move change history down into its own section.Chris McDonough
2009-01-05 New ModulesChris McDonough
- A new module ``repoze.bfg.url`` has been added. It contains the ``model_url`` API (moved from ``repoze.bfg.traversal``) and an implementation of ``urlencode`` (like Python's ``urllib.urlencode``) which can handle Unicode keys and values in parameters to the ``query`` argument. Deprecations - The ``model_url`` function has been moved from ``repoze.bfg.traversal`` into ``repoze.bfg.url``. It can still be imported from ``repoze.bfg.traversal`` but an import from ``repoze.bfg.traversal`` will emit a DeprecationWarning. Features - The ``repoze.bfg.url.model_url`` API (nee' ``repoze.bfg.traversal.model_url``) now accepts and honors a keyword argument named ``query``. The value of this argument will be used to compose a query string, which will be attached to the generated URL before it is returned. See the API docs (in the docs directory or `on the web <http://static.repoze.org/bfgdocs>`_) for more information.
2008-11-07 FeaturesChris McDonough
- Added a ``repoze.bfg.testing`` module to attempt to make it slightly easier to write unittest-based automated tests of BFG applications. Information about this class is in the documentation. - The default template renderer now supports testing better by looking for ``ITestingTemplateRenderer`` using a relative pathname. This is exposed indirectly through the API named ``registerTemplate`` in ``repoze.bfg.testing``. Deprecations - The names ``repoze.bfg.interfaces.ITemplate`` , ``repoze.bfg.interfaces.ITemplateFactory`` and ``repoze.bfg.interfaces.INodeTemplate`` have been deprecated. These should now be imported as ``repoze.bfg.interfaces.ITemplateRenderer`` and ``repoze.bfg.interfaces.ITemplateRendererFactory``, and ``INodeTemplateRenderer`` respectively. - The name ``repoze.bfg.chameleon_zpt.ZPTTemplateFactory`` is deprecated. Use ``repoze.bfg.chameleon_zpt.ZPTTemplateRenderer``. - The name ``repoze.bfg.chameleon_genshi.GenshiTemplateFactory`` is deprecated. Use ``repoze.bfg.chameleon_genshi.GenshiTemplateRenderer``. - The name ``repoze.bfg.xslt.XSLTemplateFactory`` is deprecated. Use ``repoze.bfg.xslt.XSLTemplateRenderer``.
2008-10-03 Docs Chris McDonough
- An "Environment and Configuration" chapter was added to the narrative portion of the documentation. Features - Ensure bfg doesn't generate warnings when running under Python 2.6. - The environment variable ``BFG_RELOAD_TEMPLATES`` is now available (serves the same purpose as ``reload_templates`` in the config file). - A new configuration file option ``debug_authorization`` was added. This turns on printing of security authorization debug statements to ``sys.stderr``. The ``BFG_DEBUG_AUTHORIZATION`` environment variable was also added; this performs the same duty. Bug Fixes - The environment variable ``BFG_SECURITY_DEBUG`` did not always work. It has been renamed to ``BFG_DEBUG_AUTHORIZATION`` and fixed. Deprecations - A deprecation warning is now issued when old API names from the ``repoze.bfg.templates`` module are imported. Backwards incompatibilities - The ``BFG_SECURITY_DEBUG`` environment variable was renamed to ``BFG_DEBUG_AUTHORIZATION``.
2008-09-28 FeaturesChris McDonough
- A ``repoze.bfg.location`` API module was added. Backwards incompatibilities - Applications must now use the ``repoze.bfg.interfaces.ILocation`` interface rather than ``zope.location.interfaces.ILocation`` to represent that a model object is "location-aware". We've removed a dependency on ``zope.location`` for cleanliness purposes: as new versions of zope libraries are released which have improved dependency information, getting rid of our dependence on ``zope.location`` will prevent a newly installed repoze.bfg application from requiring the ``zope.security``, egg, which not truly used at all in a "stock" repoze.bfg setup. These dependencies are still required by the stack at this time; this is purely a futureproofing move. The security and model documentation for previous versions of ``repoze.bfg`` recommended using the ``zope.location.interfaces.ILocation`` interface to represent that a model object is "location-aware". This documentation has been changed to reflect that this interface should now be imported from ``repoze.bfg.interfaces.ILocation`` instead.
2008-09-21Rendering fixes.Chris McDonough
2008-09-21Add workflow chapter, fix renderings.Chris McDonough
2008-09-03 - Add startup process docs.Chris McDonough
2008-09-01 - New API module: ``repoze.bfg.view``. This module contains the functionsChris McDonough
named ``render_view_to_response``, ``render_view_to_iterable`` and ``is_response``, which are documented in the API docs. These features aid programmatic (non-request-driven) view execution.
2008-08-20Add change history.Chris McDonough
2008-08-20Note repoze.who integrations where useful.Chris McDonough
2008-08-11repoze.shootout.Chris McDonough
2008-08-04 - Add a ``request_type`` attribute to the available attributes of aChris McDonough
``bfg:view`` configure.zcml element. This attribute will have a value which is a dotted Python path, pointing at an interface. If the request object implements this interface when the view lookup is performed, the appropriate view will be called. - Remove "template only" views. These were just confusing and were never documented.
2008-07-31More balance between URL dispatch and traversal.Chris McDonough
2008-07-31 - Add event sends for INewRequest and INewResponse. See theChris McDonough
events.rst chapter in the documentation's ``api`` directory.
2008-07-29wiki.Chris McDonough
2008-07-29(no commit message)Chris McDonough
2008-07-29(no commit message)Chris McDonough
2008-07-28(no commit message)Chris McDonough
2008-07-28(no commit message)Chris McDonough
2008-07-28(no commit message)Chris McDonough
2008-07-28Grr.Chris McDonough
2008-07-24Various tweaks.Chris McDonough
2008-07-24Sorry for the checkin spam.Chris McDonough
2008-07-24Cleanup.Chris McDonough
2008-07-24Point at the glossary at the end.Chris McDonough
2008-07-24Start working on a glossary. Also, start changing repoze.bfg occurrences to ↵Paul Everitt
:mod: as I find them.
2008-07-24We don't need cluegun.Chris McDonough
2008-07-24Get rid of duplicate info in lxmlgraph tutorial.Chris McDonough
2008-07-24Move stuff from lxmlgraph to main docs.Chris McDonough
2008-07-24Add tutorial sectionsPaul Everitt
2008-07-22Add url-based dispatch.Chris McDonough
2008-07-21Add install docs.Chris McDonough
2008-07-20More docs; fix autogen app model root creation.Chris McDonough
2008-07-20 - Add find_interface API.Chris McDonough
2008-07-19Add wsgiapp decorator.Chris McDonough
2008-07-19Document project creation.Chris McDonough