Go to file
David Lord b97165db75
type hint fix for flask.send_file (#5336)
2023-11-15 12:55:43 -08:00
.devcontainer switch docs to flit 2023-06-27 14:13:56 -07:00
.github use pip-compile instead of pip-compile-multi 2023-11-15 12:44:20 -08:00
docs Fix wrong spelling of JS method .innerHTML 2023-09-24 15:58:22 +01:00
examples use ruff linter and formatter 2023-11-15 12:14:37 -08:00
requirements use pip-compile instead of pip-compile-multi 2023-11-15 12:44:20 -08:00
requirements-skip use pip-compile instead of pip-compile-multi 2023-11-15 12:44:20 -08:00
src/flask type hint fix for flask.send_file 2023-11-15 12:53:22 -08:00
tests use ruff linter and formatter 2023-11-15 12:14:37 -08:00
.editorconfig add EditorConfig 2020-05-23 13:25:06 -07:00
.gitignore use ruff linter and formatter 2023-11-15 12:14:37 -08:00
.pre-commit-config.yaml update pre-commit hooks 2023-11-15 12:47:41 -08:00
.readthedocs.yaml update read the docs env 2023-11-15 12:19:59 -08:00
CHANGES.rst type hint fix for flask.send_file 2023-11-15 12:53:22 -08: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
README.rst remove old links 2023-04-20 09:53:38 -07:00
pyproject.toml start version 3.0.1 2023-11-15 12:50:46 -08:00
tox.ini use pip-compile instead of pip-compile-multi 2023-11-15 12:44:20 -08: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