Ferris Framework
Getting Started
Prerequisites
Getting a copy of Ferris
Configuration
Running with the App Engine development server
Tutorial: Multi-User Blog
Modeling Data
Handling Requests With Controllers
Scaffolding
Templates
Functional Testing
Extras
User’s Guide
Folder Structure
How Ferris does MVC
Models
Controllers
Authorization Chains
Request Parsers
Response Handlers
Routing
Static Files
Views
Templates
Scaffolding
Components
Behaviors
Forms
Messages
Events
Plugins
OAuth2
Settings
Memcache
Search
Mail
Uploads & Downloads
Testing
Packages
Changelog
Version 2.1.0
Version 2.0.1
Version 2.0.0
Contributing & License
Ferris Framework
Docs
»
User’s Guide
Edit on Bitbucket
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
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
Settings
Configuration
Functions
Dynamic Settings Plugin
Memcache
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