Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Jwpe/Flask-Nicely

Pretty Flask JSON responses for API building.
https://github.com/Jwpe/Flask-Nicely

Last synced: 11 days ago
JSON representation

Pretty Flask JSON responses for API building.

Awesome Lists containing this project

README

        

Flask-Nicely
============

.. image:: https://travis-ci.org/Jwpe/Flask-Nicely.png?branch=develop
:target: https://travis-ci.org/Jwpe/Flask-Nicely
.. image:: https://coveralls.io/repos/Jwpe/Flask-Nicely/badge.png?branch=develop
:target: https://coveralls.io/r/Jwpe/Flask-Nicely?branch=develop

Flask-Nicely consists of a simple decorator with which to wrap Flask
functions that return data in order to turn them into pretty, consistent
JSON responses. It also provides several built in HTTP exceptions which can
be raised in a Flask function in order to return the corresponding HTTP
error response.

Docs can be found at http://flask-nicely.readthedocs.org/

Dependencies
------------

Flask-Nicely is tested on both Python 2.7 and Python 3.3. It has only one
dependency: `Flask
`_ itself.

Installation
------------

Flask-Nicely is available on `PyPI
`_. The best way to install is
via pip, as follows:

.. code:: bash

pip install flask-nicely

Alternatively, you can download the source code directly from GitHub.

Usage
-----

The Flask-Nicely decorator is used as follows:

.. code:: python

import flask_nicely

app = Flask(__name__)

@app.route('/hello/')
@flask_nicely.nice_json
def hello(name):

data = {
"Name": name,
"Message": "Hello, {}!".format(name)
}

return data

Wrapping our view function in the decorator will cause the view to return the
following 200 response:

.. code:: json

{
"data": data,
"error": null,
"status": 200,
}

Flask-Nicely also allows you to throw HTTP exceptions which will result in a
properly formed HTTP error response. Custom exception messages may be entered:

.. code:: python

from flask import Flask

import flask_nicely
from flask_nicely.errors import NotFound

app = Flask(__name__)

@app.route('/error/404')
@flask_nicely.nice_json
def throw_404():

raise NotFound("Could not find the grail!")

This will result in the following 404 response:

.. code:: json

{
"data": null,
"error": "Could not find the grail!",
"status": 404
}

Exceptions can accept a payload, which is an arbitrary dictionary to be sent
as part of the JSON response. For example:

.. code:: python

test_payload = {
'error_detail': "The resource that you requested was not found on the server",
'documentation': "http://www.flask-nicely.readthedocs.org",
}

raise NotFound(payload=test_payload)

Will result in a 404 response containing:

.. code:: json

{
"data": null,
"error": "Not Found",
"status": 404,
"error_detail": "The resource that you requested was not found on the server",
"documentation": "http://www.flask-nicely.readthedocs.org",
}

An example app can be found in the examples directory, and can be run from
the root directory using:

.. code:: python

python examples/app.py

Testing
-------

To run the tests for the project using py.test, simply run:

.. code:: bash

python setup.py test

For multi-version testing, install and run tox:

.. code:: bash

pip install tox
tox