Narrative Documentation

This section contains comprehensive guides and explanations of Tet’s features and concepts. Start with the Introduction, then read the topics most relevant to your application — each guide is self-contained.

Getting started

• Introduction
  • What is Tet?
  • Core Philosophy
  • Key Features Overview
  • Framework Integration
  • Architecture
  • Requirements
  • Getting Help
• Configuration
  • Basic Configuration
  • Configuration Directives
  • Module Configuration
  • Settings Integration
  • Environment Configuration
  • Advanced Configuration
  • Configuration Validation
  • Configuration Utilities
  • Configuration Profiles
  • Best Practices

Application building blocks

• Dependency Injection and Services
  • Why dependency injection?
  • Service base classes
  • Declaring a service
  • Declaring dependencies with autowired
  • Registering services
  • Retrieving a service
  • The request-scoped lifecycle
  • Using services in views
  • End-to-end example
  • See also
• Extended Request and Response Objects
  • Honesty first: what is in the modules
  • Why re-export at all?
  • How the request is actually extended
  • Using the extended request in a view
  • Working with responses
  • Practical guidance
  • See also
• Views and Controllers
  • A note on imports
  • The extended view_config decorator
  • Service-aware view classes with ServiceViews
  • Traversal controllers with BaseController
  • Choosing between the styles
  • Registering and scanning
  • See also
• Viewlets
  • Why viewlets
  • The viewlet decorator
  • Injecting globals: the before-render event
  • Registering viewlets as a template global
  • Calling viewlets from templates
  • A realistic example: a user-card viewlet
  • Tips and gotchas
  • See also
• Templating with Tonnikala
  • Enabling the renderer
  • Rendering templates from views
  • Template syntax
  • Internationalized templates
  • See also
• Internationalization (i18n)
  • Enabling i18n
  • Translation string factories
  • Translating in view code
  • Template globals
  • Setting up translation directories and locales
  • See also
• Static Assets and Cache-Breaking
  • How the cachebreaker works
  • Wiring it into your application
  • Using static_url in templates
  • See also

Data and rendering

• JSON Handling
  • Safe JavaScript Serialization
  • Enhanced JSON Renderer
  • Custom JSON Adapters
  • JSON in Views
  • Performance Considerations
  • Best Practices
• SQLAlchemy Integration
  • Root Factories
  • Session Management
  • Password Hashing
  • Model Serialization
  • Testing with Databases
  • Best Practices
  • Security Considerations

Security

• Security Features
  • CSRF Protection
  • Enhanced Authorization
  • SQLAlchemy Security
  • Input Validation and Sanitization
  • Security Best Practices
  • Security Considerations

Utilities and workflow

• Utilities
  • Cryptographic Utilities
  • Base64 and Crockford Base32 Utilities
  • Collection Utilities
  • Path Utilities
  • Export Utilities
  • Shell (pshell) Utilities
  • JSON Utilities
  • Best Practices
• Decorators and Descriptors
  • deprecated
  • reify_attr
  • See also
• Testing
  • Running the Tests
  • Built-in Fixtures
  • Testing includeme Functions
  • Testing Views
  • Testing the JSON Renderer
  • Testing Safe JSON Serialization
  • Testing the SQLAlchemy Root Factory
  • Testing with a Real Database
  • Integration Testing with WebTest
  • Mock Testing
  • Test Organization
  • Continuous Integration
  • Best Practices