PyXWF – eXtensible Web Framework Documentation

Welcome to the documentation of PyXWF, an extensible web framework for Python. It is written in pure python, using the lxml and WebStack libraries.

To learn more about PyXWF, please have a look at the official PyXWF page.

Hints on notation

Throughout the documentation, we’ll be talking about XML nodes and attributes. XML nodes are referenced by <ns:name /> or ns:name, where ns: is the namespace prefix (if any) and name is the local-name of the Node. XML attributes are referenced by @ns:name, with ns: and name having the same meanings as before.

Some namespaces are used commonly with PyXWF and thus have some prefixes we consider default and useful:

• h: maps to http://www.w3.org/1999/xhtml, the XHTML namespace.
• py: maps to http://pyxwf.zombofant.net/xmlns/documents/pywebxml, the namespace for PyWebXML documents.
• site: maps to http://pyxwf.zombofant.net/xmlns/site, the namespace for sitemap.xml files.

Table of contents

• Tutorial
  • Setting up PyXWF
    • Creating the sitemap and initial data
    • Setting up WSGI
  • Going on: Adding more content
    • Adding a directory
• sitemap.xml reference
  • Basic sitemap structure
  • <meta /> — Site metadata
  • <plugins /> — Loading plugins
  • <tweaks /> — supply further configuration
    • <performance /> — settings which affect performance
    • <compatibility /> — to deal with bad user agents
    • <formatting /> — text/date formatting options
    • <templates /> — default XSL templates
    • <mimemap /> — declare file extensions
    • <html-transform /> — further custom templates
  • <:tree /> — Creating the actual site tree
  • <crumbs /> — Snippets and generated content
  • Reloading the sitemap
• Plugins user guides
  • Basic (every-day) plugins
    • PyXWF.Nodes.Page — A static page
    • PyXWF.Nodes.Directory — A directory of nodes
    • PyXWF.Nodes.Redirect — Place a redirect
  • Advanced plugins
    • PyXWF.Nodes.MirrorSwitch — Redirect to random mirror
    • PyXWF.Nodes.Transform — Generate content and trees from XSL transformations
  • Tweaks of PyXWF behaviour
    • PyXWF.Tweaks.Host — Host based behaviour
  • PyWeblog, a blogging engine
• PyWebXML user guide
  • Document type definition
    • <meta /> contents
• API reference
  • PyXWF core services
    • PyXWF.Context – One HTTP transaction context
    • PyXWF.Site — A whole Website
    • PyXWF.Message – Response messages
    • PyXWF.Templates – XSL transformation based templating
  • Caching and resource management
    • PyXWF.Cache – Caching baseclasses
    • PyXWF.Resource – Baseclass for a reloadable resource
  • Plugin framework
    • PyXWF.Registry – Metaclass magic for registering plugins
    • PyXWF.Sitleton – One instance per site
    • PyXWF.Tweaks – Obtaining and using site-wide configuration
    • PyXWF.Nodes – Nodes for the sitemap tree
    • PyXWF.Crumbs – Crumb baseclass
    • PyXWF.Parsers – Parser baseclass
    • PyXFW.Parsers.PyWebXML — The default document format for PyXWF
  • Various utilities
    • PyXWF.utils – Miscellaneous
    • PyXWF.HTTPUtils – Utility functions for HTTP
    • PyXWF.TimeUtils – Utility functions for date/time related things
    • PyXWF.AcceptHeaders – Dealing with HTTP Accept headers
    • PyXWF.Errors — Exception classes and HTTP status notifiers

Indices and tables

• Index
• Module Index
• Search Page