|
|
|
|
Flask
|
|
|
|
|
=====
|
|
|
|
|
|
|
|
|
|
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. It began as a simple wrapper around `Werkzeug`_
|
|
|
|
|
and `Jinja`_ and has become one of the most popular Python web
|
|
|
|
|
application frameworks.
|
|
|
|
|
|
|
|
|
|
Flask offers suggestions, but doesn't enforce any dependencies or
|
|
|
|
|
project layout. It is up to the developer to choose the tools and
|
|
|
|
|
libraries they want to use. There are many extensions provided by the
|
|
|
|
|
community that make adding new functionality easy.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Installing
|
|
|
|
|
----------
|
|
|
|
|
|
|
|
|
|
Install and update using `pip`_:
|
|
|
|
|
|
|
|
|
|
.. code-block:: text
|
|
|
|
|
|
|
|
|
|
pip install -U Flask
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
A Simple Example
|
|
|
|
|
----------------
|
|
|
|
|
|
|
|
|
|
.. code-block:: python
|
|
|
|
|
|
|
|
|
|
from flask import Flask
|
|
|
|
|
|
|
|
|
|
app = Flask(__name__)
|
|
|
|
|
|
|
|
|
|
@app.route('/')
|
|
|
|
|
def hello():
|
|
|
|
|
return 'Hello, World!'
|
|
|
|
|
|
|
|
|
|
.. code-block:: text
|
|
|
|
|
|
|
|
|
|
$ env FLASK_APP=hello.py flask run
|
|
|
|
|
* Serving Flask app "hello"
|
|
|
|
|
* Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Contributing
|
|
|
|
|
------------
|
|
|
|
|
|
|
|
|
|
For guidance on setting up a development environment and how to make a
|
|
|
|
|
contribution to Flask, see the `contributing guidelines`_.
|
|
|
|
|
|
|
|
|
|
.. _contributing guidelines: https://github.com/pallets/flask/blob/master/CONTRIBUTING.rst
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Donate
|
|
|
|
|
------
|
|
|
|
|
|
|
|
|
|
The Pallets organization develops and supports Flask and the libraries
|
|
|
|
|
it uses. In order to grow the community of contributors and users, and
|
|
|
|
|
allow the maintainers to devote more time to the projects, `please
|
|
|
|
|
donate today`_.
|
|
|
|
|
|
|
|
|
|
.. _please donate today: https://psfmember.org/civicrm/contribute/transact?reset=1&id=20
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Links
|
|
|
|
|
-----
|
|
|
|
|
|
|
|
|
|
* Website: https://www.palletsprojects.com/p/flask/
|
|
|
|
|
* Documentation: http://flask.pocoo.org/docs/
|
|
|
|
|
* License: `BSD <https://github.com/pallets/flask/blob/master/LICENSE>`_
|
|
|
|
|
* Releases: https://pypi.org/project/Flask/
|
|
|
|
|
* Code: https://github.com/pallets/flask
|
|
|
|
|
* Issue tracker: https://github.com/pallets/flask/issues
|
|
|
|
|
* Test status:
|
|
|
|
|
|
|
|
|
|
* Linux, Mac: https://travis-ci.org/pallets/flask
|
|
|
|
|
* Windows: https://ci.appveyor.com/project/pallets/flask
|
|
|
|
|
|
|
|
|
|
* Test coverage: https://codecov.io/gh/pallets/flask
|
|
|
|
|
|
|
|
|
|
.. _WSGI: https://wsgi.readthedocs.io
|
|
|
|
|
.. _Werkzeug: https://www.palletsprojects.com/p/werkzeug/
|
|
|
|
|
.. _Jinja: https://www.palletsprojects.com/p/jinja/
|
|
|
|
|
.. _pip: https://pip.pypa.io/en/stable/quickstart/
|
