User’s Guide¶

This guide contains detailed documentation about each component of Ferris.

Folder Structure
- Root Directory Structure
- Application Directory Structure
How Ferris does MVC
Models
- Conventions
- App Engine Integration
- Automatic Methods
- Callbacks
- Access Fields
Controllers
- Conventions
- Configuration
- Actions
- Requests
- Response
- Security
- Utilities
- The Startup Method and Events
Authorization Chains
- Using Authorizations
- Creating Authorization Functions
- Using Authorization Chains with Scaffolding
- Built-in Authorization Functions
Request Parsers
- Parsing
- The Parser Instance
Response Handlers
- Usage
- Built-in
- Custom
Routing
- Parts
- URL and Name Generation
- CRUD Actions
- Non-CRUD Actions
- Prefixes
- Generating URLs to Actions
- Checking if an action exists
- Manual Routing
Static Files
Views
- Context
- Switching Views
- Template View
- JSON View
- Message View
- Custom Views
- Events
Templates
- Conventions
- Concepts
- Templates
- Providing and Accessing Data
- Layouts
- Elements
- Macros
- Built-in Macros
- Overloading
- Themes
- Functions, Filters, and Context
- Value Formatting
- Events
- Manual Rendering
Scaffolding
- Using Scaffolding
- Actions
- Templates
- Admin Scaffolding
- Component Integration
- Events
- Configuration
- Macros
Components
- Using Components
- Creating Components
- Built-in Components
Behaviors
- Using Behaviors
- Creating Behaviors
Forms
- Model Form
- Using Forms in Controller
- Using Forms in Views
Messages
- Message Classes
- Model Messages
- Message Responses
- Message Requests
- JSON REST APIs
Events
- listeners.py
- Emitting Events
- Examples
Plugins
- Creating A Plugin
- Enabling Plugins
- Using Plugins
- Plugin Assets
OAuth2
- Configuration
- Example
- The OAuth Component
- Admin Credentials
- Using Credentials
- Finding Credentials
- The Oauth Manager
- OAuth2 Service Accounts
Google API Helper
- Building Clients
- Exponential Backoff
- Discovery Document Caching
Settings
- Configuration
- Functions
- Dynamic Settings Plugin
Caching
- Decorators
- Utility Functions
- Backends
Search
- Indexing Models
- Performing Searches
- Macros
- Advanced Usage
Mail
Uploads & Downloads
- Uploads
- Downloads
- Cloud Storage
Testing
- Installing the nose plugin
- Running tests
- Writing tests for models
- Writing tests for controllers
- Writing tests for the entire application
Packages
- Included Third-Party Libraries