No description
Find a file
pgjones 08a283af5e
Allow loading of environment variables into the config
This new method will pick out any environment variables with a certain
prefix and place them into the config named without the prefix. This
makes it easy to use environment variables to configure the app as is
now more popular than when Flask started.

The prefix should ensure that the environment isn't polluted and the
config isn't polluted by environment variables.

I've followed the dynaconf convention of trying to parse the
environment variable and then falling back to the raw value if parsing
fails.
2022-03-25 11:54:03 -07:00
.github Bump actions/setup-python from 2 to 3 2022-03-01 16:04:16 +00:00
artwork fix list numbering 2021-10-01 19:46:54 -07:00
docs Allow loading of environment variables into the config 2022-03-25 11:54:03 -07:00
examples update tests for relative redirects 2022-03-25 11:48:26 -07:00
requirements update requirements 2022-02-09 07:39:33 -08:00
src/flask Allow loading of environment variables into the config 2022-03-25 11:54:03 -07:00
tests Allow loading of environment variables into the config 2022-03-25 11:54:03 -07:00
.editorconfig add EditorConfig 2020-05-23 13:25:06 -07:00
.gitignore Add venv and .venv to .gitignore 2021-05-21 16:58:58 +08:00
.pre-commit-config.yaml pin setuptools for reorder_python_imports 2022-02-17 16:26:06 -08:00
.readthedocs.yaml pin os and python version in rtd build 2021-12-22 20:06:08 -07:00
CHANGES.rst update tests for relative redirects 2022-03-25 11:48:26 -07:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2019-05-06 12:41:01 -04:00
CONTRIBUTING.rst Improve the contributing guide 2021-06-14 14:20:04 +08: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 update pip link 2021-08-10 06:07:21 -07:00
setup.cfg Merge branch '2.0.x' 2022-01-13 14:43:23 -08:00
setup.py cli: use importlib.metadata instead of pkg_resources 2022-01-17 19:36:57 +03:00
tox.ini Merge branch '2.0.x' 2021-11-15 13:26:06 -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 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/
-   Website: https://palletsprojects.com/p/flask/
-   Twitter: https://twitter.com/PalletsTeam
-   Chat: https://discord.gg/pallets