Akshar Raaj a9b22af9bc Fixed documentation in 'Design Decisions in Flask'		12 years ago
artwork	Updated license, relicensed logo under debian-ish license	15 years ago
docs	Fixed documentation in 'Design Decisions in Flask'	12 years ago
examples	Merge pull request #625 from soulseekah/master	12 years ago
flask	Add import to jsonify example.	12 years ago
scripts	fixed issue #524	13 years ago
.gitignore	Added a tox-test command that runs Flask tests with tox	15 years ago
.gitmodules	added theme submodule	15 years ago
.travis.yml	Stop the joinspam	12 years ago
AUTHORS	Added changelog entry and entry into authors file	14 years ago
CHANGES	Documented new signal message_flashed	12 years ago
LICENSE	2013	12 years ago
MANIFEST.in	Updated manifests	14 years ago
Makefile	Removed tox file	12 years ago
README.md	update README to markdown	12 years ago
run-tests.py	Do not break extension tests if tested with installed extensions.	13 years ago
setup.cfg	Removed dev tag from setup.cfg. Fixes #596	12 years ago
setup.py	Various improvements in regards to the itsdangerous usage, bumped to 0.17	13 years ago

README.md

Flask

Web development, one drop at a time

What is Flask?

Flask is a microframework for Python based on Werkzeug and Jinja2. It's intended for getting started very quickly and was developed with best intentions in mind.

Is it ready?

It's still not 1.0 but it's shaping up nicely and is already widely used. Consider the API to slightly improve over time but we don't plan on breaking it.

What do I need?

Jinja 2.4 and Werkzeug 0.7 or later. pip or easy_install will install them for you if you do pip install Flask. I encourage you to use a virtualenv. Check the docs for complete installation and usage instructions.

Where are the docs?

Go to http://flask.pocoo.org/docs/ for a prebuilt version of the current documentation. Otherwise build them yourself from the sphinx sources in the docs folder.

Where are the tests?

Good that you're asking. The tests are in the flask/testsuite package. To run the tests use the run-tests.py file:

$ python run-tests.py

If it's not enough output for you, you can use the --verbose flag:

$ python run-tests.py --verbose

If you just want one particular testcase to run you can provide it on the command line:

$ python run-tests.py test_to_run

Where can I get help?

Either use the #pocoo IRC channel on irc.freenode.net or ask on the mailinglist: http://flask.pocoo.org/mailinglist/

See http://flask.pocoo.org/community/ for more resources.