Pylons Reference Documentation

Getting Started with Pylons

• Getting Started
  • Requirements
  • Installing
  • Creating a Pylons Project
  • Running the application
  • Hello World
• Concepts of Pylons
  • The ‘Why’ of a Pylons Project
  • WSGI Applications
  • WSGI Middleware
  • Controller Dispatch
  • Paster
  • Loading the Application

MVC Reference

• Controllers
  • Standard Controllers
  • Using the WSGI Controller to provide a WSGI service
  • Using the REST Controller with a RESTful API
  • Using the XML-RPC Controller for XML-RPC requests
• Views
  • Templates
  • Passing Variables to Templates
  • Default Template Variables
  • Configuring Template Engines
  • Custom render() functions
  • Templating with Mako
• Models
  • About the model
  • Model Basics
  • Organizing
  • Creating a Model
  • Adding a Relation
  • Creating the Database
  • A brief guide to using model objects in the Controller
  • Logging
  • About SQLAlchemy
• Advanced Models
  • Advanced SQLAlchemy
  • Non-SQLAlchemy libraries
  • Object Databases
  • Popular No-SQL Databases

Project Configuration and Logging

• Configuration
  • Runtime Configuration
  • Environment
  • URL Configuration
  • Middleware
  • Application Setup
• Logging
  • Logging messages
  • Basic Logging configuration
  • Filtering log messages
  • Advanced Configuration
  • Request logging with Paste’s TransLogger
  • Logging to wsgi.errors

Forms, Validation, and Helpers

• Helpers
  • Pagination
  • Secure Form Tag Helpers
• Forms
  • The basics
  • Getting Started
  • Using the Helpers
  • File Uploads
  • Validating user input with FormEncode
  • Other Form Tools

Internationalization, Sessions, and Caching

• Internationalization and Localization
  • Introduction
  • Getting Started
  • Using Babel
  • Back To Work
  • Testing the Application
  • Fallback Languages
  • Translations Within Templates
  • Lazy Translations
  • Producing a Python Egg
  • Plural Forms
  • Summary
  • Further Reading
  • babel.core – Babel core classes
  • babel.localedata — Babel locale data
  • babel.dates – Babel date classes
  • babel.numbers – Babel number classes
• Sessions
  • Sessions
  • The Session Object
  • Configuring the Session
  • Storing SQLAlchemy mapped objects in Beaker sessions
  • Custom and caching middleware
  • Using Session in Internationalization
  • Using Session in Secure Forms
  • Hacking the session for no cookies
  • Using middleware (Beaker) with a composite app
• Caching
  • Types of Caching
  • Namespaces and Keys
  • Configuring
  • Browser-Side
  • Controller Actions
  • Templates
  • Arbitrary Functions
  • Fragments

Testing, Upgrading, and Deploying

• Unit and functional testing
  • Unit Testing with webtest
  • Example: Testing a Controller
  • Testing Pylons Objects
  • Testing Your Own Objects
  • Unit Testing
  • Functional Testing
• Errors, Troubleshooting, and Debugging
  • Error Middleware
  • Interactive Debugging
  • E-mailing Errors
  • Programmatically Handling Errors
• Upgrading
  • 1.0 -> 1.0.1
  • 0.9.7 -> 1.0
• Packaging and Deployment Overview
  • Egg Files
  • Installing as a Non-root User
  • Understanding the Setup Process
  • Deploying the Application
  • Advanced Usage
• Running Pylons Apps with Other Web Servers
  • Using Fast-CGI
  • Apache Configuration
  • PrefixMiddleware
  • Using Java Web Servers with Jython
• Documenting Your Application
  • Introduction
  • Tutorial
  • Learning ReStructuredText
  • Using Docstrings
  • Using doctest
  • Summary
• Distributing Your Application
  • Running Your Application

Installation for Windows / Python 2.3

• Python 2.3 Installation Instructions
  • Advice of end of support for Python 2.3
  • Preparation
  • System-wide Install
• Windows Notes
  • For Win2K or WinXP
  • For Windows 95, 98 and ME
  • Finally

Pylons on Jython

• Pylons on Jython
  • Installation
  • Deploying to Java Web servers

Advanced Pylons

• Security policy for bugs
  • Receiving Security Updates
  • Reporting Security Issues
  • Minimising Risk
• WSGI support
  • Paste and WSGI
  • Using a WSGI Application as a Pylons 0.9 Controller
  • Running a WSGI Application From Within a Controller
  • Configuring Middleware Within a Pylons Application
  • The Cascade
  • Useful Resources
• Advanced Pylons
  • WSGI, CLI scripts
  • Adding commands to Paster
  • Creating Paste templates
  • Using Entry Points to Write Plugins
• Pylons Execution Analysis
  • The sample application
  • Pylons’ dependencies
  • The analysis

Module Listing

• Pylons Modules
  • pylons.commands – Command line functions
  • pylons.configuration – Configuration object and defaults setup
  • pylons.controllers – Controllers
  • pylons.controllers.core – WSGIController Class
  • pylons.controllers.util – Controller Utility functions
  • pylons.controllers.xmlrpc – XMLRPCController Class
  • pylons.decorators – Decorators
  • pylons.decorators.cache – Cache Decorators
  • pylons.decorators.rest – REST-ful Decorators
  • pylons.decorators.secure – Secure Decorators
  • pylons.error – Error handling support
  • pylons.i18n.translation – Translation/Localization functions
  • pylons.log – Logging for WSGI errors
  • pylons.middleware – WSGI Middleware
  • pylons.templating – Render functions and helpers
  • pylons.test – Test related functionality
  • pylons.util – Paste Template and Pylons utility functions
  • pylons.wsgiapp – PylonsWSGI App Creator
• Third-party components
  • FormEncode
  • weberror – Weberror
  • webtest – WebTest
  • webob – Request/Response objects
• Glossary

For further information, indices are available:

Indices

• Index
• Module Index
• Search Page
• Glossary