2019-01-05 14:59:25 -08:00
|
|
|
.. rst-class:: hide-header
|
2010-05-24 08:38:28 +02:00
|
|
|
|
2010-04-06 16:02:14 +02:00
|
|
|
Welcome to Flask
|
|
|
|
|
================
|
|
|
|
|
|
2025-06-12 13:46:49 -07:00
|
|
|
.. image:: _static/flask-name.svg
|
2018-09-17 08:35:28 -07:00
|
|
|
:align: center
|
2025-06-09 14:31:31 -07:00
|
|
|
:height: 200px
|
2010-04-10 15:49:15 +02:00
|
|
|
|
2023-10-07 00:37:42 +01:00
|
|
|
Welcome to Flask's documentation. Flask is a lightweight WSGI web application framework.
|
|
|
|
|
It is designed to make getting started quick and easy, with the ability to scale up to
|
|
|
|
|
complex applications.
|
|
|
|
|
|
|
|
|
|
Get started with :doc:`installation`
|
2020-04-04 12:57:14 -07:00
|
|
|
and then get an overview with the :doc:`quickstart`. There is also a
|
|
|
|
|
more detailed :doc:`tutorial/index` that shows how to create a small but
|
2018-02-07 06:56:14 -08:00
|
|
|
complete application with Flask. Common patterns are described in the
|
2020-04-04 12:57:14 -07:00
|
|
|
:doc:`patterns/index` section. The rest of the docs describe each
|
|
|
|
|
component of Flask in detail, with a full reference in the :doc:`api`
|
|
|
|
|
section.
|
2010-04-06 16:02:14 +02:00
|
|
|
|
2023-04-20 11:34:48 -07:00
|
|
|
Flask depends on the `Werkzeug`_ WSGI toolkit, the `Jinja`_ template engine, and the
|
|
|
|
|
`Click`_ CLI toolkit. Be sure to check their documentation as well as Flask's when
|
|
|
|
|
looking for information.
|
2010-04-16 12:21:31 +02:00
|
|
|
|
2023-04-20 11:34:48 -07:00
|
|
|
.. _Werkzeug: https://werkzeug.palletsprojects.com
|
|
|
|
|
.. _Jinja: https://jinja.palletsprojects.com
|
|
|
|
|
.. _Click: https://click.palletsprojects.com
|
2010-04-16 12:21:31 +02:00
|
|
|
|
2019-06-23 12:27:25 -07:00
|
|
|
|
|
|
|
|
User's Guide
|
|
|
|
|
------------
|
|
|
|
|
|
2022-08-05 11:28:22 -07:00
|
|
|
Flask provides configuration and conventions, with sensible defaults, to get started.
|
|
|
|
|
This section of the documentation explains the different parts of the Flask framework
|
|
|
|
|
and how they can be used, customized, and extended. Beyond Flask itself, look for
|
|
|
|
|
community-maintained extensions to add even more functionality.
|
2019-06-23 12:27:25 -07:00
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
|
|
|
|
|
installation
|
|
|
|
|
quickstart
|
|
|
|
|
tutorial/index
|
|
|
|
|
templating
|
|
|
|
|
testing
|
|
|
|
|
errorhandling
|
2020-07-28 11:14:17 -07:00
|
|
|
debugging
|
2019-06-23 12:27:25 -07:00
|
|
|
logging
|
|
|
|
|
config
|
|
|
|
|
signals
|
|
|
|
|
views
|
2023-02-10 14:48:02 -08:00
|
|
|
lifecycle
|
2019-06-23 12:27:25 -07:00
|
|
|
appcontext
|
|
|
|
|
blueprints
|
|
|
|
|
extensions
|
|
|
|
|
cli
|
|
|
|
|
server
|
|
|
|
|
shell
|
|
|
|
|
patterns/index
|
2024-04-07 10:24:40 -07:00
|
|
|
web-security
|
2019-06-23 12:27:25 -07:00
|
|
|
deploying/index
|
2026-01-25 10:31:31 -08:00
|
|
|
gevent
|
2021-04-06 15:31:28 -07:00
|
|
|
async-await
|
2019-06-23 12:27:25 -07:00
|
|
|
|
|
|
|
|
|
|
|
|
|
API Reference
|
|
|
|
|
-------------
|
|
|
|
|
|
|
|
|
|
If you are looking for information on a specific function, class or
|
|
|
|
|
method, this part of the documentation is for you.
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
|
|
|
|
|
api
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Additional Notes
|
|
|
|
|
----------------
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
|
|
|
|
|
design
|
|
|
|
|
extensiondev
|
|
|
|
|
contributing
|
2021-02-24 10:09:38 -08:00
|
|
|
license
|
|
|
|
|
changes
|
