No description
Find a file
2023-08-16 13:29:25 -07:00
.devcontainer switch docs to flit 2023-06-27 14:13:56 -07:00
.github Bump pypa/gh-action-pypi-publish from 1.8.7 to 1.8.8 (#5213) 2023-08-01 09:59:06 -07:00
docs Update install.rst with required description 2023-07-03 05:51:06 -07:00
examples switch examples to flit 2023-06-27 14:13:56 -07:00
requirements switch docs to flit 2023-06-27 14:13:56 -07:00
src/flask fix use of importlib.util.find_spec 2023-06-09 09:34:42 -07:00
tests use tmp_path instead of tmpdir 2023-05-02 10:38:27 -07:00
.editorconfig add EditorConfig 2020-05-23 13:25:06 -07:00
.flake8 stop ignoring flake8 e402 2023-01-19 06:35:15 -08:00
.gitignore remove references to mailing list 2022-05-10 09:28:43 -07:00
.pre-commit-config.yaml [pre-commit.ci] pre-commit autoupdate 2023-07-04 06:36:29 +00:00
.readthedocs.yaml pin os and python version in rtd build 2021-12-22 20:06:08 -07:00
CHANGES.rst switch docs to flit 2023-06-27 14:13:56 -07:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2019-05-06 12:41:01 -04:00
CONTRIBUTING.rst switch docs to flit 2023-06-27 14:13:56 -07:00
LICENSE.rst standardize license and copyright 2019-06-22 13:09:09 -07:00
pyproject.toml switch to flit build backend 2023-06-27 14:13:56 -07:00
README.rst remove old links 2023-04-20 09:53:38 -07:00
tox.ini simplify tox config 2023-06-27 08:29:41 -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.

.. _WSGI: https://wsgi.readthedocs.io/
.. _Werkzeug: https://werkzeug.palletsprojects.com/
.. _Jinja: https://jinja.palletsprojects.com/


Installing
----------

Install and update using `pip`_:

.. code-block:: text

    $ pip install -U Flask

.. _pip: https://pip.pypa.io/en/stable/getting-started/


A Simple Example
----------------

.. code-block:: python

    # save this as app.py
    from flask import Flask

    app = Flask(__name__)

    @app.route("/")
    def hello():
        return "Hello, World!"

.. code-block:: text

    $ flask run
      * 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/main/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://palletsprojects.com/donate


Links
-----

-   Documentation: https://flask.palletsprojects.com/
-   Changes: https://flask.palletsprojects.com/changes/
-   PyPI Releases: https://pypi.org/project/Flask/
-   Source Code: https://github.com/pallets/flask/
-   Issue Tracker: https://github.com/pallets/flask/issues/
-   Chat: https://discord.gg/pallets