Web   ·   Wiki   ·   Activities   ·   Blog   ·   Lists   ·   Chat   ·   Meeting   ·   Bugs   ·   Git   ·   Translate   ·   Archive   ·   People   ·   Donate
summaryrefslogtreecommitdiffstats
path: root/app/static/doc/flask-docs/_sources/extensions.txt
diff options
context:
space:
mode:
Diffstat (limited to 'app/static/doc/flask-docs/_sources/extensions.txt')
-rw-r--r--app/static/doc/flask-docs/_sources/extensions.txt48
1 files changed, 48 insertions, 0 deletions
diff --git a/app/static/doc/flask-docs/_sources/extensions.txt b/app/static/doc/flask-docs/_sources/extensions.txt
new file mode 100644
index 0000000..53dca56
--- /dev/null
+++ b/app/static/doc/flask-docs/_sources/extensions.txt
@@ -0,0 +1,48 @@
+Flask Extensions
+================
+
+Flask extensions extend the functionality of Flask in various different
+ways. For instance they add support for databases and other common tasks.
+
+Finding Extensions
+------------------
+
+Flask extensions are listed on the `Flask Extension Registry`_ and can be
+downloaded with ``easy_install`` or ``pip``. If you add a Flask extension
+as dependency to your ``requirements.rst`` or ``setup.py`` file they are
+usually installed with a simple command or when your application installs.
+
+Using Extensions
+----------------
+
+Extensions typically have documentation that goes along that shows how to
+use it. There are no general rules in how extensions are supposed to
+behave but they are imported from common locations. If you have an
+extension called ``Flask-Foo`` or ``Foo-Flask`` it will be always
+importable from ``flask.ext.foo``::
+
+ from flask.ext import foo
+
+Flask Before 0.8
+----------------
+
+If you are using Flask 0.7 or earlier the :data:`flask.ext` package will not
+exist, instead you have to import from ``flaskext.foo`` or ``flask_foo``
+depending on how the extension is distributed. If you want to develop an
+application that supports Flask 0.7 or earlier you should still import
+from the :data:`flask.ext` package. We provide you with a compatibility
+module that provides this package for older versions of Flask. You can
+download it from github: `flaskext_compat.py`_
+
+And here is how you can use it::
+
+ import flaskext_compat
+ flaskext_compat.activate()
+
+ from flask.ext import foo
+
+Once the ``flaskext_compat`` module is activated the :data:`flask.ext` will
+exist and you can start importing from there.
+
+.. _Flask Extension Registry: http://flask.pocoo.org/extensions/
+.. _flaskext_compat.py: https://github.com/mitsuhiko/flask/raw/master/scripts/flaskext_compat.py