No description
Find a file
David Lord 31d3c7e719
Merge pull request #3270 from pallets/metadata
update project metadata
2019-06-23 15:43:47 -07:00
.github Rename GitHub templates to md. They are Markdown. 2017-12-02 09:17:18 +01:00
artwork standardize license and copyright 2019-06-22 13:09:09 -07:00
docs fix docks linkcheck 2019-06-23 15:37:51 -07:00
examples Revert "Close tag on js examples." 2018-04-21 15:12:06 +09:00
flask standardize license and copyright 2019-06-22 13:09:09 -07:00
tests standardize license and copyright 2019-06-22 13:09:09 -07:00
.azure-pipelines.yml remove codecov 2019-06-12 10:35:35 -07:00
.gitattributes update project metadata 2018-02-08 12:43:22 -08:00
.gitignore use theme provided by pallets-sphinx-themes 2018-04-18 12:05:31 -07:00
CHANGES.rst use sphinx-issues, rewrap changelog 2019-06-23 12:25:38 -07:00
CONTRIBUTING.rst fix docks linkcheck 2019-06-23 15:37:51 -07:00
LICENSE.rst standardize license and copyright 2019-06-22 13:09:09 -07:00
MANIFEST.in standardize project metadata 2019-06-22 13:10:50 -07:00
README.rst standardize project metadata 2019-06-22 13:10:50 -07:00
setup.cfg standardize project metadata 2019-06-22 13:10:50 -07:00
setup.py standardize project metadata 2019-06-22 13:10:50 -07:00
tox.ini remove codecov 2019-06-12 10:35:35 -07:00

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

    $ FLASK_APP=hello.py flask run
     * Serving Flask app "hello"
     * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)


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/
* Releases: https://pypi.org/project/Flask/
* Code: https://github.com/pallets/flask
* Issue tracker: https://github.com/pallets/flask/issues
* Test status: https://dev.azure.com/pallets/pallets/_build?definitionId=2
* Official chat: https://discord.gg/t6rrQZH

.. _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/