Welcome to Flask

Welcome to Flask’s documentation. This documentation is divided in different parts. I would suggest to get started with the Installation and then heading over to the Quickstart. Besides the quickstart there is also a more detailed Tutorial that shows how to create a complete (albeit small) application with Flask. If you rather want to dive into all the internal parts of Flask, check out the API documentation. Common patterns are described in the Patterns for Flask section.

Flask also depends on two external libraries: the Jinja2 template engine and the Werkzeug WSGI toolkit. both of which are not documented here. If you want to dive into their documentation check out the following links:

• Jinja2 Documentation
• Werkzeug Documentation

Textual Documentation

This part of the documentation is written text and should give you an idea how to work with Flask. It’s a series of step-by-step instructions for web development.

• Foreword
  • What does Micro Mean?
  • A Framework and An Example
  • Web Development is Dangerous
  • Target Audience
• Installation
  • virtualenv
  • System Wide Installation
  • The Drop into Place Version
  • easy_install on Windows
• Quickstart
  • A Minimal Application
  • Debug Mode
  • Routing
  • Static Files
  • Rendering Templates
  • Accessing Request Data
  • Redirects and Errors
  • Sessions
  • Message Flashing
• Tutorial
  • Introducing Flaskr
  • Step 0: Creating The Folders
  • Step 1: Database Schema
  • Step 2: Application Setup Code
  • Step 3: Creating The Database
  • Step 4: Request Database Connections
  • Step 5: The View Functions
  • Step 6: The Templates
  • Step 7: Adding Style
  • Bonus: Testing the Application
• Testing Flask Applications
  • The Application
  • The Testing Skeleton
  • The First Test
  • Logging In and Out
  • Test Adding Messages
• Patterns for Flask
  • Larger Applications
  • Using SQLite 3 with Flask
  • SQLAlchemy in Flask
  • Template Inheritance
  • Message Flashing
• Deployment Options
  • FastCGI
  • mod_wsgi (Apache)
  • Tornado
  • Gevent
  • CGI
• Becoming Big
  • What Could Be Improved?
  • Why does not Flask do all that by Default?

Reference

If you are looking for information on a specific function, class or method, this part of the documentation is for you:

• API
  • Application Object
  • Incoming Request Data
  • Response Objects
  • Sessions
  • Application Globals
  • Useful Functions and Classes
  • Message Flashing
  • Template Rendering