Go to file
David Lord ae07dead24
Merge pull request #5140 from Jeroendevr/patch-1
2023-05-31 09:14:56 -07:00
.devcontainer Add a devcontainer configuration (#4969) 2023-04-13 10:03:49 -07:00
.github update workflows 2023-05-09 12:37:33 -07:00
docs Config from Data Files to match from_file API 2023-05-24 11:13:36 +02:00
examples update dependencies 2023-05-02 07:17:52 -07:00
requirements update dependencies 2023-05-02 07:17:52 -07:00
src/flask Allow for PathLike types for config file variables 2023-05-14 16:09:25 +01: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 Merge branch '2.2.x' 2023-04-25 11:41:20 -06:00
.readthedocs.yaml pin os and python version in rtd build 2021-12-22 20:06:08 -07:00
CHANGES.rst Merge branch '2.2.x' into 2.3.x 2023-05-02 07:50:30 -07:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2019-05-06 12:41:01 -04:00
CONTRIBUTING.rst fix typo 2023-04-15 07:39:35 -07:00
LICENSE.rst standardize license and copyright 2019-06-22 13:09:09 -07:00
MANIFEST.in Initial typing support 2021-04-26 17:20:24 +01:00
README.rst remove old links 2023-04-20 09:53:38 -07:00
pyproject.toml update werkzeug 2023-05-01 08:18:03 -07:00
tox.ini drop support for python 3.7 2023-04-20 11:09:55 -07:00

README.rst

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