You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
David Lord 7e714bd28b
Merge pull request #2969 from codeaditya/update-links
6 years ago
.github Use https for external links wherever possible 6 years ago
artwork Added lineart logo 9 years ago
docs Use https for external links wherever possible 6 years ago
examples Add prefix for all commands in documentation (#2877) 6 years ago
flask Merge pull request #2962 from garenchan/dev 6 years ago
scripts update project metadata 7 years ago
tests Merge branch '1.0-maintenance' 7 years ago
.appveyor.yml update test envs 7 years ago
.gitattributes update project metadata 7 years ago
.gitignore use theme provided by pallets-sphinx-themes 7 years ago
.travis.yml update test envs 7 years ago
AUTHORS update project metadata 7 years ago
CHANGES.rst Merge branch '1.0-maintenance' 7 years ago
CONTRIBUTING.rst Use https for external links wherever possible 6 years ago
LICENSE update project metadata 7 years ago
MANIFEST.in update project metadata 7 years ago
Makefile Remove now obsolete 'audit' command from Makefile 7 years ago
README.rst Make explicit call-out to contributing guidelines in README 7 years ago
setup.cfg move coveragerc to setup.cfg 7 years ago
setup.py Exclude 3.3 aswell. 7 years ago
tox.ini update test envs 7 years ago

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

$ 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://www.palletsprojects.com/p/flask/
* Documentation: http://flask.pocoo.org/docs/
* License: `BSD <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/