The Pylons Modern Apocrypha

The Pylons Modern Apocrypha

Warning

This is NOT the official Pylons documentation. This is merely a convenience collection of documentation of third-party apps and libraries pertinent to Pylons in many ways but inappropriate for inclusion in the official Pylons documentation.

Go to The official Pylons documentation

Warning

(Also note that the breadcrumb generator is very simplistic and assumes, wrongly in some cases, that each subsection has an index document. If faced with a 404, go back to the last doc and skip up a level in the breadcrumb trail.)

Warning

Toscawidgets and tw.forms sections are duplicated (-ish), the suffix ‘latest’ refers to the docs copied over from the corresponding Mercurial repository. (This duplication will be resolved in the immediate future)

date:July 28, 2010 author:Graham Higgins <gjh@bel-epa.com>

AuthKit

• AuthKit
  • AuthKit Manual
  • 1   Credits
  • 2   The Basics
    • Authentication
    • Authorization
  • 3   The AuthKit Architecture
    • Authentication Middleware
    • Permission Objects
    • Authorization Objects
    • User Management API
    • Framework Adaptors
  • 4   Authentication Middleware
    • 4.1   Configuration
    • 4.2   Advanced Configuration Options
    • 4.3   Authentication Methods
    • 4.4   Basic HTTP/1.0 Authentication
    • 4.5   Digest HTTP/1.1 Authentication
    • 4.6   Form-Based Authentication
    • 4.7   Forwarding
    • 4.8   OpenID Passurl
    • 4.9   Custom Middleware
    • 4.10   Cookie Options
  • 5   Authorization
    • 5.1   Permission Objects
    • 5.2   Checking Permissions with Authorize Objects
    • 5.3   Using the User Management API
    • 5.4   Manually Handling User Management
  • 6   Further Reading
  • Authenticaton and Authorization - Pylons integration
  • 1   The Basics
  • 2   Getting Started
  • 3   Private Data
  • 4   Using Pylons’ __before__ method and session functionality
  • 5   Using AuthKit
    • 5.1   Authentication
    • 5.2   Authorization
    • 5.3   Using Permissions
  • 6   User Management
    • 6.1   Managing Users From a Database, LDAP Connection, ZODB or elsewhere
  • 7   More Complex Examples
  • 8   Other Authentication and Authorization Systems
  • 9   Known Issues
  • authkit – AuthKit - authentication and authorisation facilities
    • Authorization objects for checking permissions
    • Permission objects
    • Authentication middleware
    • Objects representing users, their passwords, roles and groups
    • Pylons specific code to facilitate using AuthKit with Pylons
    • HTTP digest authentication middleware
    • Internal forward middleware for manual authentication handling
    • Form and cookie based authentication middleware
    • HTTP basic authentication middleware
    • Cookie handling based on paste.auth.auth_tkt but with some bug fixes and improvements
    • Middleware that can dynamically change the stack based on status or headers
    • Highly flexible OpenID based authentication middleware

Repoze.who

• repoze.who – WSGI Authentication Middleware
  • Middleware Responsibilities
  • Configuration Points
    • Classifiers
    • Challenge Deciders
    • Plugins
  • Lifecycle of a Request
    • Request (Ingress) Stages
    • Response (Egress) Stages
  • Plugin Types
    • Identifier Plugins
    • Authenticator Plugins
    • Metadata Provider Plugins
    • Challenger Plugins
  • Default Plugin Implementations
  • Middleware Configuration via Python Code
  • Middleware Configuration via Config File
  • Writing repoze.who Plugins
    • Writing An Identifier Plugin
    • Writing an Authenticator Plugin
    • Writing a Challenger Plugin
    • Writing a Metadata Provider Plugin
  • Interfaces

Contributing to the Pylons docs

• Contributing to the Pylons documentation
  • Getting a copy of the latest sources
  • Making changes, adding documents, etc.
  • Adding to and updating the local clone of the Pylons repository.
  • Creating a bundle of changesets ready for despatch
  • Effecting the contribution

Installing with buildout

• Installing with buildout
  • How to install Pylons with buildout
    • Contents
  • Initialize a buildout for your project
  • Creating and running a project
  • Useful tips
    • Development vs production
    • Default configuration
    • Avoid loading site.py

Using Elixir with Pylons

• Using Elixir with Pylons
  • An introduction to using Elixir with Pylons (and SQLAlchemy)
  • Pylons, Elixir, metadata and engine binding
    • Model metadata and the Session
    • Binding to an engine and setting up the tables
    • Creating an engine and initialising the tables and mapper
  • Using existing tables
  • Database schema versioning
    • sqlalchemy-migrate
    • miruku
  • Indices and tables

FormBuild

• FormBuild 2.1.0
  • Contents:
    • Using FormBuild in Pylons
    • FormBuild Classes and helpers
    • Formbuild Manual
  • Indices and tables

FormEncode

• Formencode documentation
  • FormEncode Validation
    • Introduction
    • Using Validation
  • FormEncode API
    • Core API
    • Validators
    • Validator Modifiers
    • HTML Parsing and Form Filling
  • formencode.validators – lots of useful validators
    • Module Contents
  • formencode.htmlfill – Fill in HTML forms
    • Module Contents

Mako Forms

• Using Mako to present and handle forms
  • Update

Paste

• Python Paste
  • URL Parsing With WSGI And Paste
    • Introduction and Audience
    • URL Parsing
    • Dispatching
    • Motivations
    • Finding Applications
    • Modifying The Request
    • Object Publishing
  • The Paste HTTP Server Thread Pool
    • Error Cases
    • Paste Thread Pool
    • Notification
    • Missed Cases
    • watch_threads
    • socket_timeout
  • Features
    • Testing
    • Server
    • Dispatching
    • Web Application
    • Tools
    • Authentication
    • Debugging Filters
    • Other Tools

PasteDeploy

• Paste Deployment
  • paste.deploy.loadwsgi – Load WSGI applications from config files
    • Module Contents
  • paste.deploy.config – Configuration and Environment middleware
    • Module Contents
  • paste.deploy.converters – Conversion helpers for String Configuration
    • Module Contents
  • Introduction
  • Status
  • Installation
  • From the User Perspective
    • The Config File
  • Basic Usage
  • config: URIs
    • Config Format
    • Applications
    • Configuration
    • Global Configuration
    • Composite Applications
    • Other Objects
    • Filter Composition
    • Getting Configuration
  • egg: URIs
  • Defining Factories
    • paste.app_factory
    • paste.composite_factory
    • paste.filter_factory
    • paste.filter_app_factory
    • paste.server_factory
    • paste.server_runner
  • Outstanding Issues

PasteScript

• Paste Script
  • paste.script.checkperms – functions to check and diff file permissions
    • Module Contents
  • paste.script.command – framework for paster commands
    • Module Contents
  • paste.script.copydir – recursive, interactive copy
    • Module Contents
  • paste.script.filemaker – interactive file writing helpers
    • Module Contents
  • paste.script.templates – framework for paster create templates
    • Module Contents
  • paste.script.testapp – simple test WSGI application
    • Module Contents
  • paste.script.util.secret – create random secrets
    • Module Contents
  • Paste Script: Development
    • Introduction
    • What Paste Script Can Do
    • How’s the Local Thing Work?
    • What Do Commands Look Like?
    • Templates
  • Introduction
  • Status
  • paster serve
  • Configuration
  • Running the Server
  • #! Scripts

Profiling SQL with Dozer

• Profiling SQL in Pylons with Dozer

Pylons 1.0 docs

• Pylons Reference Documentation
  • Getting Started with Pylons
    • Getting Started
    • Concepts of Pylons
  • Tutorials
    • Pylons Tutorials
  • MVC Reference
    • Controllers
    • Views
    • Models
  • Project Configuration and Logging
    • Configuration
    • Logging
  • Forms, Validation, and Helpers
    • Helpers
    • Forms
  • Internationalization, Sessions, and Caching
    • Internationalization and Localization
    • Sessions
    • Caching
  • Testing, Upgrading, and Deploying
    • Unit and functional testing
    • Errors, Troubleshooting, and Debugging
    • Upgrading
    • Packaging and Deployment Overview
    • Running Pylons Apps with Other Web Servers
    • Documenting Your Application
    • Distributing Your Application
  • Installation for Windows / Python 2.3
    • Python 2.3 Installation Instructions
    • Windows Notes
  • Pylons on Jython
    • Pylons on Jython
  • Advanced Pylons
    • Security policy for bugs
    • WSGI support
    • Advanced Pylons
  • Module Listing
    • Pylons Modules
    • Third-party components
    • Glossary
• Indices

Routes

• Routes Documentation
  • Routes Manual
    • Introduction
    • Vocabulary
    • Setting up routes
    • Generation
    • Unicode
    • RESTful services
    • Redirect routes
    • Other
    • Using Routes with Pylons and WebHelpers
  • Porting Routes to other frameworks
    • URL Resolution
    • Setting up the Request Configuration
  • Changes in Routes
    • Routes Changelog
    • Release 1.11 (tip)
    • Release 1.10.3 (February 8, 2009)
    • Release 1.10.2 (January 11, 2009)
    • Release 1.10.1 (September 27, 2008)
    • Release 1.10 (September 24, 2008)
    • Release 1.9.2 (July 8, 2008)
    • Release 1.9.1 (June 28, 2008)
    • Release 1.9 (June 12, 2008)
    • Release 1.8 (March 28, 2008)
    • Release 1.7.3 (May 28th, 2008)
    • Release 1.7.2 (Feb. 27th, 2008)
    • Release 1.7.1 (Nov. 16th, 2007)
    • Release 1.7 (June 8th, 2007)
    • Release 1.6.3 (April 10th, 2007)
    • Release 1.6.2 (Jan. 5, 2007)
    • Release 1.6.1 (Dec. 29, 2006)
    • Release 1.6 (Dec. 14th, 2006)
    • Release 1.5.2 (Oct. 16th, 2006)
    • Release 1.5.1 (Oct. 4th, 2006)
    • Release 1.5 (Sept. 19th, 2006)
    • Release 1.4.1 (Sept. 6th, 2006)
    • Release 1.4 (July 21, 2006)
    • Release 1.3.2 (April 30th, 2006)
    • Release 1.3.1 (April 4th, 2006)
    • Release 1.3 (Feb. 25th, 2006)
    • Release 1.2 (Feb. 17th, 2006)
    • Release 1.1 (Jan. 13th, 2006)
    • Release 1.0.2 (Dec. 30th, 2005)
    • Release 1.0.1 (Dec. 18th, 2005)
    • Release 1.0 (Nov. 21st, 2005)
  • Glossary
• Indices and tables
  • Module Listing
    • routes – Routes module

RDFAlchemy

• rdfalchemy – RDFAlchemy
• RDFAlchemy
  • Related resources
    • Installation
    • Code
    • SVN
    • User Group
    • API Docs
  • Capabilities
  • SQL Alchemy
  • Descriptors
    • Chained predicates
    • Chained descriptors
  • Hybrid SQL/RDF Alchemy Objects
  • CRUD
    • Create
    • Read
    • Update
    • Delete
  • Utility methods
  • Literals in RDFAlchemy
    • Literal to Python
  • decimal
    • Literal to Python
    • Python to Literal
  • datetime
    • Literal to Python
  • Other RDF mappers
• SPARQL Endpoints
  • Standalone use
  • Sesame endpoints
  • Joseki endpoints
  • Relational Data thru SPARQL
    • D2R Server
    • Other SPARQL / SQL maps
• Sesame
  • Standalone use
  • RDFAlchemy use of Sesame
  • Other Python SPARQL endpoints
• Jython
  • rdfalchemy
  • rdfalchemy.rdfSubject
  • rdfalchemy.rdfsSubject
  • rdfalchemy.commands
  • rdfalchemy.descriptors
  • rdfalchemy.orm
  • rdfalchemy.sparl
  • rdfalchemy.sparl.sesame2
  • rdfalchemy.engine

Shabti

• Shabti
  • Contents
    • Introduction
      • Philosophy and design goals
    • Getting started
      • Creating an application using Shabti templates
    • The Shabti Templates
      • shabti – Elixir and SQLAlchemy
      • shabti_auth – boilerplate authentication
      • shabti_auth_xp – row authentication
      • shabti_auth_couchdb – identity on CouchDB
      • shabti_auth_rdfalchemy – RDF-based auth’n’auth
      • shabti_auth_repozewho – authentication using repoze.who
      • shabti_auth_repozewhat – auth’n’auth using repoze.what
      • shabti_auth_repozepylons – auth’n’auth in Pylons using repoze.wh[o|at]
      • shabti_authplus – Auth’n’auth plus user-managed signup
      • shabti_formalchemy – “Pylons Admin” Web UI
      • shabti_humanoid – Auth’n’auth SQLA declarativeBase model
      • shabti_moinmoin – Shabti with integrated MoinMoin wiki
      • shabti_pyblosxom – Shabti with integrated Pyblosxom blog
      • shabti_quickwiki – Pylons QuickWiki, using elixir
      • shabti_rdfalchemy – an Object-RDF Mapper
      • shabti_microsite – a kick-the-tyres microsite
      • shabti_shenu – a blogging application
      • shabti_rdflib – handling RDF and SPARQL
      • shabti_existxml – using an XML native database (NYI)
      • shabti_soap – basic SOAP services (NYI)
      • shabti_atompub - a Pylons atompub solution (NYI)
      • shabti_xmpp – working with publish and subscribe (NYI)
    • Migrations package
    • Commands added to Paster
    • A note about the template engine
    • Reporting bugs and asking questions
    • Licence
    • Status
    • Credits

SQLAlchemy-migrate

• SQLAlchemy Migrate - SQLAlchemy schema change management
  • Download and Development of SQLAlchemy Migrate
    • Download
    • Development
  • Documentation
    • Database schema versioning
    • Database changeset API
    • SQLAlchemy migrate tools
    • API Documentation
• Indices and tables

Toscawidgets-latest

• ToscaWidgets Documentation
  • Introduction
  • Contents
    • Installing and Enabling ToscaWidgets
    • ToscaWidgets Usage
    • Configuration of ToscaWidgets
    • Serverside Callbacks
    • Integrating ToscaWidgets with a Web Framework
    • Frequently Asked Questions
    • Creating a Widget
    • Deploying projects which use ToscaWidgets
    • Aggregating resources with ToscaWidgets
    • Require once - Guarding Javascript against multiple inclusion
    • Module Reference
    • Contributors
    • Changelog
    • License
  • Indices and tables

tw.forms-latest

• Using ToscaWidgets to create Forms
  • Introduction
  • Tutorial
  • Basic Form
  • Form Template
  • The Controller
  • Advanced Exercise
  • Do More With Forms
    • Field Attributes
    • Form Fields
  • Form Validation
    • Available Validators
• tw.forms Documentation
  • Contents
    • Building a Form with tw.forms
    • Module Documentation
    • tw.forms Changelog
  • Indices and tables

tw.dynforms

• Welcome to tw.dynforms’s documentation!
  • Tutorial
    • Introduction
    • Getting Started
    • Model
    • Front Page
    • Form Editing
    • Hiding
    • Growing
    • Ajax Lookups
    • Select with Other
    • Further Customisation
    • Future Directions
  • Widgets
  • Other Module Contents
    • DeleteButton
    • HidingContainerMixin
    • HidingLoopError
    • HidingMissingError
    • IntNull
    • load_options
    • SearchError
    • strip_wo_markers
    • StripDictValidator
  • Notes
    • Grandchild widgets
• Indices and tables

Toscawidgets

• ToscaWidgets
  • Contents
    • Installation
    • Modules
    • Examples
    • Deploying projects which use ToscaWidgets
    • Frequently Asked Questions
  • Indices and tables

tw.forms

• Using ToscaWidgets to create Forms
  • Introduction
  • Tutorial
  • Basic Form
  • Form Template
  • The Controller
  • Advanced Exercise
  • Do More With Forms
    • Field Attributes
    • Form Fields
  • Form Validation
    • Available Validators
• tw.forms
  • Contents
    • Introduction to tw.forms
    • Tutorials
    • Modules
  • Indices and tables

Tutorials

• Tutorials
  • Flickr search tutorial
    • Introduction
    • Getting Started
    • Flickr API Key
    • Setup the JavaScripts and autohandler
    • Write The Controller and Templates
    • Add Some Style
    • Quick Recap
  • Using tw.forms with Pylons. Part 1
    • Introduction
    • Scope
    • Requirements
    • Installation
    • Configuring ToscaWidgets
    • Building your first tw.forms form
    • Displaying the form
    • Using the form in your application
    • Using the form to validate input
  • Using tw.forms with Pylons. Part 2
    • Using fancy fields
    • Styling the form
  • Using Fixture To Test A Pylons + SQLAlchemy App
    • Creating An Address Book
    • Defining The Model
    • Creating A Simple Controller
    • Adding Some Data Sets
    • Loading Initial Data
    • Setting Up The Test Suite
    • Defining A Fixture
    • Testing With Data
    • A Note About Session Mappers and Elixir
    • Why Do I Keep Getting InvalidRequestError?
    • Example Source
  • Testing Pylons apps
    • Introduction
    • Building your first thing

Webhelpers-1

• WebHelpers
  • Contents
    • Overview
    • WebHelpers Documentation
    • Indices and tables
    • WebHelpers ChangeLog
    • webhelpers.constants
    • webhelpers.containers
    • webhelpers.date
    • webhelpers.feedgenerator
    • webhelpers – WebHelpers module

Webhelpers-0

• webhelpers – Web Helpers package
  • Current
    • constants – Useful constants (Geo-lists)
    • containers Handy Containers
    • date – Date helpers
    • feedgenerator – Feed generator
    • webhelpers.html – HTML handling
    • webhelpers.markdown – Markdown
    • mimehelper – MIMEtypes helper
    • misc – Miscellaneous helpers
    • number – Numbers and statistics helpers
    • paginate – Paging and pagination
    • webhelpers.pylonslib – flash alert div helpers
    • text – Text helpers
    • textile – Textile
    • util – Utilities
  • Deprecated
    • webhelpers.commands.compress_resources – (deprecated)
    • hinclude (deprecated)
    • htmlgen (deprecated)
    • pagination – WebHelpers Pagination (part deprecated)
    • rails WebHelpers Rails (deprecated)

WebOb

• WebOb
  • WebOb Reference
    • Introduction
    • Request
    • Response
    • Exceptions
  • webob – Request/Response objects
    • Request
    • Response
    • Misc Functions
    • Descriptors
  • Differences Between WebOb and Other Systems
    • paste.wsgiwrappers and Pylons
    • Django
    • CherryPy/TurboGears
    • Yaro
    • Werkzeug
    • Zope 3
    • mod_python
  • WebOb File-Serving Example
  • Comment Example
    • Introduction
    • Code
    • Instantiating Middleware
    • The Middleware
    • Accepting Comments
    • Conclusion
  • Another Do-It-Yourself Framework
    • Introduction and Audience
    • What Is WSGI?
    • About WebOb
    • Serving Your Application
    • Making A Framework
    • Routing
    • Controllers
    • Putting It Together
    • Another Controller
    • URL Generation and Request Access
    • Templating
    • Conclusion
  • Status & License
  • Introduction
  • Request
    • URLs
    • Methods
    • Unicode
  • Response
    • Headers
    • Instantiating the Response
  • Exceptions
  • Multidict
  • Example

The Missing Pylons Documentation

• The Missing Pylons Documentation
  • Contents
    • The Missing Pylons documentation - WebOb Request
    • Status
    • Credits

Indices

• Index
• Module Index
• Search Page