No description
Find a file
Yuhesh Pandian.P.J 3efbfababc
⬆️ Update README.rst
Added some more badges
2024-01-01 20:41:27 +05:30
.devcontainer switch docs to flit 2023-06-27 14:13:56 -07:00
.github Bump the github-actions group with 2 updates 2023-12-01 15:47:14 +00:00
docs Merge branch '3.0.x' 2023-12-13 15:13:41 -08:00
examples use ruff linter and formatter 2023-11-09 10:27:01 -08:00
requirements Bump the python-requirements group in /requirements with 3 updates 2023-12-13 14:58:31 -08:00
requirements-skip use pip-compile instead of pip-compile-multi 2023-11-09 08:56:36 -08:00
src/flask Merge branch '3.0.x' 2023-12-13 15:13:41 -08:00
tests use ruff linter and formatter 2023-11-09 10:27:01 -08:00
.editorconfig add EditorConfig 2020-05-23 13:25:06 -07:00
.gitignore use ruff linter and formatter 2023-11-09 10:27:01 -08:00
.pre-commit-config.yaml [pre-commit.ci] pre-commit autoupdate 2023-12-04 20:29:39 +00:00
.readthedocs.yaml update read the docs env 2023-11-09 08:39:48 -08:00
CHANGES.rst Fixing issue 5342: 'The double quote is missing in the string' 2023-12-13 15:05:03 -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
pyproject.toml run typing tests 2023-12-13 16:27:37 -08:00
README.rst ⬆️ Update README.rst 2024-01-01 20:41:27 +05:30
tox.ini use pip-compile instead of pip-compile-multi 2023-11-09 08:56:36 -08: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 & Update** via `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

~~~~~

.. raw:: html

    <div align="center" style="display: flex; justify-content: center;">
        <div style="display: flex; justify-content: center;">
            <img src="https://img.shields.io/pypi/v/Flask?style=for-the-badge&logoColor=blue" alt="PyPi Package Version">
            <img src="https://img.shields.io/pypi/dm/Flask?style=for-the-badge" alt="PyPi Downloads">
            <img alt="Maintenance" src="https://img.shields.io/maintenance/yes/2024?style=for-the-badge&color=orange">
            <img alt="GitHub Release Date - Published_At" src="https://img.shields.io/github/release-date/pallets/flask?style=for-the-badge">
            <img alt="Conda Downloads" src="https://img.shields.io/conda/d/conda-forge/python?style=for-the-badge">
        </div>
    </div>