TurboGears 1.5 Documentation

Contents

• TurboGears 1.5 Documentation
  • Guides
  • Reference documents
  • Errors

TurboGears is a rapid development, “front-to-back”, open source web meta-framework. Its aim is to simplify and speed up the development of modern web applications written in the Python programming language.

TurboGears is designed around the model-view-controller architecture, much like Struts or Ruby on Rails, and takes the best Python web components available (hence “meta-framework”) and combines them into one easy-to-install, documented whole.

TurboGears 1.5 is the latest major release of the TurboGears 1 branch. This is the official 1.5 documentation. Or are you looking for a different version?

Important

The documentation for TurboGears is still being reorganized and updated. Fortunately, much of the documentation for TurboGears 1.0 is valid also for version 1.5. We kindly ask users to also look into the TurboGears 1.0 documentation until we finish our updates. If you want to lend us a hand, follow the community links below! We apologize for any inconvenience!

Guides

• The Big Picture: How Does TurboGears work?
• What’s new in TurboGears 1.5
• TurboGears 1.5 Upgrade Guide
• Download and Installation
• 20 Minutes Wiki
• Getting started with TurboGears 1.5
• Controller Getting Started Guide
• Passing Arguments to the Controller
• QuickStart your Project
• The TurboGears Administration Tool
• The TurboGears ToolBox
• The TurboGears Widget Browser
• Using SQLAlchemy
• Simple Model with Elixir
• Create the Database
• Add some Bootstrap Data
• Design Your URLs
• Using your URLs
• Write Your Controller Methods
• Write Your Templates
• Genshi Templating
• Widgets Overview
• Simple Widget Form Tutorial
• Widgets Templating Engines
• Getting Started With Identity
• Using Identity
• Using the Visit Framework
• Visit Based Sessions
• Add some Static Files
• Basic Moves when Playing with TurboGears
• JSON: Returning Data for AJAX Requests
• Design a Front-End with AJAX and Widgets
• Testing Your Application
• Test Driven Development
• Porting Guide from SQLObject to Elixir
• Replacing TurboGears Widgets with ToscaWidgets
• Creating Big Applications
• Deploying TurboGears 1.5 on a Server
• Custom Error Reporting
• Making HTTPS Redirects Work With a Reverse Proxy
• Handling Recurring Tasks: The TurboGears Scheduler
• Sample Application using Genshi and Elixir
• Read/Write Cookies in ExtJS format
• Some of the Inner Workings of TurboGears

Reference documents

• The components of TurboGears
• The structure of a TurboGears project
• Configuration setting reference
• Exposing methods with the @expose() decorator
• Validation with the @validate() decorator
• Error handling and the @error_handler() decorator
• Pagination with the @paginate() decorator
• The identity framework and the @require() decorator
• Internationalization
• TurboGears 1.5 development plans
• API reference
• License
• Module Index
• Search Page

Errors

If you find errors or deficiencies in the code or in the documentation, please create a ticket using the bug tracker of the TurboGears 1 project on SourceForge. If it’s an error in the documentation, please set the Component field to ‘documentation’. We also have a mailing list where you can ask questions or make suggestions concerning the code or the documentation.