No description
Find a file
pgjones 829aa65e64
Support loading configuration from text files
TOML is a very popular format now, and is taking hold in the Python
ecosystem via pyproject.toml (among others). This allows toml config
files via,

    app.config.from_file("config.toml", toml.loads)

it also allows for any other file format whereby there is a loader
that takes a string and returns a mapping.
2019-10-18 09:15:47 -07:00
.github Comment out helpful tips in issue_template.md 2019-07-08 01:07:45 +05:30
artwork standardize license and copyright 2019-06-22 13:09:09 -07:00
docs Support loading configuration from text files 2019-10-18 09:15:47 -07:00
examples Merge branch '1.0.x' 2019-07-01 10:54:31 -07:00
src/flask Support loading configuration from text files 2019-10-18 09:15:47 -07:00
tests Support loading configuration from text files 2019-10-18 09:15:47 -07:00
.azure-pipelines.yml Merge branch '1.0.x' 2019-06-12 10:41:11 -07:00
.gitignore use theme provided by pallets-sphinx-themes 2018-04-18 12:05:31 -07:00
.pre-commit-config.yaml Merge branch '1.0.x' 2019-06-12 10:41:11 -07:00
CHANGES.rst get_cookie_name in SessionInterface for easier overriding in SecureCookieSessionInterface 2019-10-12 19:12:27 -07:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2019-05-06 12:41:01 -04:00
CONTRIBUTING.rst Fix link to header in CONTRIBUTING (#3382) 2019-10-06 13:26:00 -07:00
LICENSE.rst standardize license and copyright 2019-06-22 13:09:09 -07:00
MANIFEST.in standardize project metadata 2019-06-22 13:10:50 -07:00
README.rst release version 1.1.1 2019-07-08 10:58:12 -07:00
setup.cfg Merge branch '1.0.x' 2019-06-23 16:57:52 -07:00
setup.py release version 1.1.1 2019-07-08 10:58:12 -07:00
tox.ini Merge branch '1.0.x' 2019-06-12 10:41:11 -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.


Installing
----------

Install and update using `pip`_:

.. code-block:: text

    pip install -U Flask


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

.. code-block:: python

    from flask import Flask

    app = Flask(__name__)

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

.. code-block:: text

    $ env FLASK_APP=hello.py flask run
     * Serving Flask app "hello"
     * 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/master/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://psfmember.org/civicrm/contribute/transact?reset=1&id=20


Links
-----

* Website: https://palletsprojects.com/p/flask/
* Documentation: https://flask.palletsprojects.com/
* Releases: https://pypi.org/project/Flask/
* Code: https://github.com/pallets/flask
* Issue tracker: https://github.com/pallets/flask/issues
* Test status: https://dev.azure.com/pallets/flask/_build
* Official chat: https://discord.gg/t6rrQZH

.. _WSGI: https://wsgi.readthedocs.io
.. _Werkzeug: https://www.palletsprojects.com/p/werkzeug/
.. _Jinja: https://www.palletsprojects.com/p/jinja/
.. _pip: https://pip.pypa.io/en/stable/quickstart/