TurboGears Documentation:

TurboGears 2 is a reinvention of the TurboGears project to take advantage of new components, and to provide a fully customizable WSGI (Web Server Gateway Interface) stack. From the beginning TurboGears was designed to be a Full Stack framework built from best-of-breed components. New components have been released which improved on the ones in the original TGstack, and the Python web world has been increasingly designed around WSGI.

This has enabled a whole new world of reuse, and TG2 is designed to take advantage of this fact in order to make a framework which provides easy to use, productive defaults, while still providing flexibility where it’s useful.

TG2 represents a change from some of the components in TurboGears 1, but we’re now invested in a set of components that we think will continue to be at the center of python web development for years to come.

Getting Started with TurboGears

Get TurboGears 2 installed, learn how to create a new TurboGears project in a single command, and of course explore the obligatory “Hello World” example, with a few fun treats thrown in.

• How to install TurboGears 2
  • Prerequisites
  • Setting up a Virtual Environment
  • Install Turbogears 2
  • Installing the development version of Turbogears 2 (from source)

• Quickstarting a TurboGears 2 project
  • Run the server
  • Explore the rest of the quickstarted project code

Tutorials

Are you the type who learns by doing? If so this section is for you. Our ultimate goal is to provide several tutorials on TG2 including everything from the basics, to advanced topics.

• The TurboGears 2 Wiki Tutorial
  • Setup
  • Quickstart
  • Controller and View
  • Wiki Model and Database
  • Adding Controllers
  • Adding Views (Templates)
  • Editing pages
  • Saving our edits
  • What about WikiWords?
  • Hey, where’s the page?
  • Adding a page list
  • Further Exploration
• TODO list

• Using ToscaWidgets to create Forms
  • Introduction
  • Tutorial
  • Basic Form
  • Form Template
  • The Controller
  • Advanced Exercise
  • Do More With Forms
  • Form Validation

• Authentication and Authorization in TurboGears 2
  • Overview
  • The three pillars: Users, groups and permissions
  • Getting started, quickly
  • Beyond the quickstart

What’s new in TG2

• What’s new in TurboGears 2
  • The “why” of TurboGears 2
  • New Features to TurboGears 2:
  • Compatibility
  • Command changes
  • Project layout changes
  • New imports

General Reference for MVC Components

• Writing controller methods
  • Quick Example
  • Are you sure you wanted to expose strings all the time?
  • SubControllers and the URL Hierarchy
  • Passing Arguments to the Controller
  • What’s new in TG2
  • Restful Dispatch
  • Content Types and Request Extensions
  • The new TG2 Lookup Method

• Working with Genshi in your Views/Templates
  • Simple genshi example
  • Available Processing Directives:
  • Genshi gotchas
  • Further Reading

• Working with SQLAlchemy and your data model
  • TurboGears Integration
  • Getting Started
  • Defining your own tables
  • Choosing data Types
  • Basic Object Relational Mapping
  • Using non-default names for auth-related classes
  • Quick database creation
  • Getting help

• Database Schema Migration in TurboGears 2
  • Prerequisites
  • Getting Started
  • Integrating sqlalchemy-migrate in the Development Process
  • Additional Information and Help

Validation, Form handling and form widgets

• TurboGears Form handling overview:
  • Process overview

• FormEncode @validate, and TurboGears Validation
  • Validating arguments (without form widgets)
  • Validating widget based forms
  • Schema validation
  • Converting URL strings to Python types manually

• Using ToscaWidgets to create Forms
  • Introduction
  • Tutorial
  • Basic Form
  • Form Template
  • The Controller
  • Advanced Exercise
  • Do More With Forms
  • Form Validation

• ToscaWidgets
  • Using Existing Widgets
  • Using ToscaWidgets to create Forms
  • Developing Toscawidgets
  • Existing ToscaWidgets Packages
  • Creating ToscaWidgets Libraries
  • Future Plans
  • ToscaWidgets FAQ
  • ToscaWidgets Cookbook

Recipes for Installation and Deployment

• Deployment options
  • Apache Deployment options:
  • NGINX deployment
  • Packaging your app as an egg:
  • Reference

• mod_proxy – Running TG2 behind Apache
  • Using Apache as a Reverse Proxy

• mod_wsgi
  • Install modwsgideploy
  • Run modwsgi_deploy
  • Example
• Possible gotchas

Development Tools

• ToolBox
  • Goal
  • Terminology
  • Features
  • Basic Gadgets
  • Spec
  • Write a simple Gadget
  • Future Plan

• What is PasteScript?
• How it integrates with TurboGears 2?
• Which are the TurboGears commands?
  • paster quickstart
  • paster serve
  • paster tginfo
  • paster shell
  • paster setup-app

• Profiling your app
  • Installing repoze.profile
  • Gathering profile data
  • Viewing profile data

TG2 Extensions

• tg.ext.silverplate
  • Classes

• tg.ext.geo.commands – tg.ext.geo Commands
  • Module Contents
• tg.ext.geo TileCache Tutorial
  • Introduction
  • About this Tutorial
  • Installation
  • Creating a New TG2 App
  • Add tg.ext.geo Paster Plugin
  • Create a TileCache Config
  • Creating the Tiles Controller
  • Rendering the Tiles in an OpenLayers Map
  • See TileCache in Action
• tg.ext.geo MapFish Tutorial
  • Introduction
  • About this Tutorial
  • Installation
  • Creating a New TG2 App
  • Add tg.ext.geo Paster Plugin
  • Create a MapFish Layers Config
  • Creating the Geo Model and Controller
  • Displaying the Vector Data as a Layer in an OpenLayers Map
  • See tg.ext.geo and tw.openlayers in Action

Other TG Tools

• TurboGears 2 Configuration
  • Overview
  • The config module
  • Setting up the base configuration for your app
  • Configuration in the INI files
• Advanced Configuration
  • Modifying the environment loader and middleware stack
  • Embedding a TG app inside another TG app
  • Using AppConfig outside of a quickstarted project:

• Caching in TurboGears 2
  • Arbitrary caching within controllers
  • Using the cache decorator
• Using the ETag cache

• Configuring and using the Logging System

• Handling internationalization and localization
  • Language auto-select
  • An i18n Quick Start
  • Commands

• Web Session Usage
  • Why use sessions?
  • How to use sessions?

Recipes

• repoze.who – Authentication in TurboGears 2 applications
  • How it works
  • How it works in TurboGears applications
  • Advanced topics

• Using PyAMF with TurboGears2
  • Installing Stuff:
  • Creating the PyAMF gateway:
  • Setup a controller that uses the GatewayController WSGI app:
  • Create a Flex Client

• Routes Integration in TG2

• Serving static files (CSS, JavaScript, images, etc)
  • Getting rid of the static file middleware
  • Reference

Performance and optimization:

Not all sites are going to be performance constrained, and not all performance constraints are created equal. Premature optimization can get you into a lot of trouble if you’re not careful, but knowing and doing a few simple things up front can help you to handle huge traffic loads when they come.

These guides are not intended to be exhaustive descriptions of web-application performance and scalability issues, but rather to provide some simple advice for those who are expecting large traffic loads.

General Project Information

• TurboGears 2 Project Status
  • TG2 Core functionality
  • General pre-release TurboGears 2 tasks:

• Contributing to TurboGears 2
  • Installing the Development Version of Turbogears 2 (from source)
  • Coding style
  • Testing
  • Documentation
  • Documenting Changes
  • How to Submit a Patch

• TurboGears Licenses
  • TurboGears

• TurboGears and Pylons Working Together

Indices and tables

• Index
• Module Index
• Search Page