Document the Flask adapter

This commit is contained in:
Christophe de Vienne 2013-03-28 11:38:20 +01:00
parent d6e36463b1
commit 6955678e97
3 changed files with 42 additions and 1 deletions

View File

@ -62,7 +62,7 @@ Main features
- Extensible : easy to add more protocols or more base types.
- Framework independance : adapters are provided to easily integrate
your API in any web framework, for example a wsgi container,
Pecan_, TurboGears_, cornice_...
Pecan_, TurboGears_, Flask_, cornice_...
- Very few runtime dependencies: webob, simplegeneric. Optionnaly lxml and
simplejson if you need better performances.
- Integration in `Sphinx`_ for making clean documentation with
@ -70,6 +70,7 @@ Main features
.. _Pecan: http://pecanpy.org/
.. _TurboGears: http://www.turbogears.org/
.. _Flask: http://flask.pocoo.org/
.. _cornice: http://pypi.python.org/pypi/cornice
Install

View File

@ -4,6 +4,8 @@ Changes
next
----
* New Flask adapter: wsmeext.flask
* Fix: Submodules of wsmeext were missing in the packages.
* Fix: The demo app was still depending on the WSME-Soap package (which has

View File

@ -110,6 +110,44 @@ Example
print("Got a message: %s" % info.message)
.. _adapter-flask:
Flask
-----
*"Flask is a microframework for Python based on Werkzeug, Jinja 2 and good intentions. And before you ask: It's BSD licensed! "*
.. warning::
Flask support is limited to function signature handling. It does not
support additional protocols. This is a temporary limitation, if you have
needs on that matter please tell us at python-wsme@googlegroups.com.
:mod:`wsmeext.flask` -- Flask adapter
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. module:: wsmeext.flask
.. function:: signature(return_type, \*arg_types, \*\*options)
See @\ :func:`signature` for parameters documentation.
Can be used on a function before routing it with flask.
Example
~~~~~~~
.. code-block:: python
from wsmeext.flask import signature
@app.route('/multiply')
@signature(int, int, int)
def multiply(a, b):
return a * b
.. _adapter-pecan:
Pecan