Go to file
David Lord 0123e65787
Merge pull request #2717 from filipefilardi/master
Add LICENSE in README
2018-04-23 09:02:23 -07:00
.github Rename GitHub templates to md. They are Markdown. 2017-12-02 09:17:18 +01:00
artwork
docs document cli option env vars 2018-04-20 13:25:04 -07:00
examples Revert "Close tag on js examples." 2018-04-21 15:12:06 +09:00
flask Fix index example for TaggedJSONSerializer.register() 2018-04-19 14:16:11 +01:00
scripts update project metadata 2018-02-08 12:43:22 -08:00
tests Fix default index for TaggedJSONSerializer.register() 2018-04-19 14:16:11 +01:00
.appveyor.yml cleanup 2018-01-04 07:29:15 -08:00
.gitattributes update project metadata 2018-02-08 12:43:22 -08:00
.gitignore use theme provided by pallets-sphinx-themes 2018-04-18 12:05:31 -07:00
.travis.yml install python in travis osx env 2018-02-08 13:04:19 -08:00
AUTHORS update project metadata 2018-02-08 12:43:22 -08:00
CHANGES.rst fix changelog indentation 2018-04-18 23:03:17 -07:00
CONTRIBUTING.rst rewrite tutorial docs and example 2018-04-09 00:53:25 -07:00
LICENSE update project metadata 2018-02-08 12:43:22 -08:00
MANIFEST.in update project metadata 2018-02-08 12:43:22 -08:00
Makefile update project metadata 2018-02-08 12:43:22 -08:00
README.rst Add LICENSE in README 2018-04-23 09:00:41 -07:00
setup.cfg move coveragerc to setup.cfg 2018-04-12 12:37:35 -07:00
setup.py use theme provided by pallets-sphinx-themes 2018-04-18 12:05:31 -07:00
tox.ini use theme provided by pallets-sphinx-themes 2018-04-18 12:05:31 -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.


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

    $ FLASK_APP=hello.py flask run
     * Serving Flask app "hello"
     * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)


Links
-----

* Website: https://www.palletsprojects.com/p/flask/
* Documentation: http://flask.pocoo.org/docs/
* License: https://github.com/pallets/flask/blob/master/LICENSE
* Releases: https://pypi.org/project/Flask/
* Code: https://github.com/pallets/flask
* Issue tracker: https://github.com/pallets/flask/issues
* Test status:

  * Linux, Mac: https://travis-ci.org/pallets/flask
  * Windows: https://ci.appveyor.com/project/pallets/flask

* Test coverage: https://codecov.io/gh/pallets/flask

.. _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/