TurboGears2 CookBook

The CookBook is a collection of documentation and patterns common to TurboGears2

Basic Recipes

• Creating and Validating Forms
  • Displaying Forms
  • Validating Fields
  • Relocatable Widget Actions
• DataGrid Tutorial
  • Preparing Application
  • Basic DataGrid
  • Paginating DataGrid
  • Sorting Columns
  • Edit Column Button
• TurboGears Automatic CRUD Generation
  • Overview
  • EasyCrudRestController
  • Custom CrudRestController
  • Customizing Crud Operations
  • Menu Items
  • Customizing The Admin
• SQLAlchemy Master Slave Load Balancing
  • Enabling Master Slave Balancing
  • Configuring Balanced Nodes
  • Driving the balancer
  • Debugging Balancing
• Deploying TurboGears
  • Running a TurboGears under Apache with mod_wsgi
  • Running a TurboGears under Circus and Chaussette
  • Running a TurboGears under Heroku
• Upgrading Your TurboGears Project
  • From 2.3 to 2.3.1
  • From 2.2 to 2.3
  • From 2.1 to 2.2

Advanced Recipes

• Streaming Response
  • Making your application streaming compliant
  • Streaming with Generators
  • Accessing TurboGears objects
• Scheduling Tasks
  • Installation
  • Setup
  • Scheduling Tasks
• Using Multiple Databases In TurboGears
  • Define your database urls in the [app:main] section of your .ini file(s)
  • Change The Way Your App Loads The Database Engines
  • Update Your Model’s __init__ To Handle Multiple Sessions And Metadata
  • Tell Your Models Which Engine To Use
  • Optional: Create And Populate Each Database In Websetup.py
• Autogenerated Forms with Sprox
  • Establishing the Model Definition
  • The Basic Sprox Form
  • Omitting Fields
  • Limiting fields
  • Field Ordering
  • Overriding Field Attributes
  • Overriding a Form Field
  • Field Widget Args
  • Custom Dropdown Field Names
  • Creating Custom Dropdown Data
  • Adding a New Field
  • Validation
  • Overriding a Validator
  • Overriding both Field and Validator
  • Required Fields
  • Form Validation
  • Conclusion

Contributing to TurboGears

• Preparing Your Development Environment
  • Installing and Using Git
  • Create A virtualenv
  • Installing TurboGears2
• Testing Your Changes
• Preparing a Release of TurboGears
  • Prerequisites
  • Summary of Steps
  • Ticket System Triage
  • Repository Branching
  • Closing Remaining Tickets
  • Upgrading all local packages as high as possible
  • Testing Jenkins With The Upgraded Packages And Code
  • Finalizing Changes On ‘next’ Branch
  • Preparing Changelog And Release Announcement
  • Preparing Packages And The Documentation
  • Uploading The Documentation
  • Making The Source Distribution For The New Eggbasket
  • Making The New Eggbasket The Current On Turbogears.org
  • Pushing to PyPI
  • Publishing Release Annoucement And Closing Milestones
  • Final Cleanup