A simple JSON API framework based on Tornado
Project description
# Tornado-JSON
[![Build Status](https://travis-ci.org/hfaran/Tornado-JSON.png?branch=master)](https://travis-ci.org/hfaran/Tornado-JSON) [![Coverage Status](https://coveralls.io/repos/hfaran/Tornado-JSON/badge.png)](https://coveralls.io/r/hfaran/Tornado-JSON?branch=master) [![Documentation Status](https://readthedocs.org/projects/tornado-json/badge/?version=latest)](https://readthedocs.org/projects/tornado-json/?badge=latest) [![Stories in Ready](https://badge.waffle.io/hfaran/Tornado-JSON.png?label=In_Progress)](http://waffle.io/hfaran/Tornado-JSON)
[![Latest Version](https://pypip.in/version/Tornado-JSON/badge.svg)](https://pypi.python.org/pypi/Tornado-JSON/) [![Downloads](https://pypip.in/download/Tornado-JSON/badge.svg)](https://pypi.python.org/pypi/Tornado-JSON/) [![Supported Python versions](https://pypip.in/py_versions/Tornado-JSON/badge.svg)](https://pypi.python.org/pypi/Tornado-JSON/) [![Development Status](https://pypip.in/status/Tornado-JSON/badge.svg)](https://pypi.python.org/pypi/Tornado-JSON/) [![Download format](https://pypip.in/format/Tornado-JSON/badge.svg)](https://pypi.python.org/pypi/Tornado-JSON/) [![License](https://pypip.in/license/Tornado-JSON/badge.svg)](https://pypi.python.org/pypi/Tornado-JSON/)
## Overview
Tornado-JSON is a small extension of [Tornado](http://www.tornadoweb.org/en/stable/) with the intent of providing the tools necessary to get a JSON API up and running quickly.
Some of the key features the included modules provide:
Input and output [JSON Schema](http://json-schema.org/) validation by decorating RequestHandlers with @schema.validate
Automated route generation with routes.get_routes(package)
Automated [GFM](https://help.github.com/articles/github-flavored-markdown)-formatted API documentation using schemas and provided descriptions
Standardized JSON output using the [JSend](http://labs.omniti.com/labs/jsend) specification
## Getting Started/FAQ
How do I use this thing?
Check out the [Hello World demo](https://github.com/hfaran/Tornado-JSON/tree/master/demos/helloworld) for a quick example and the [accompanying walkthrough](http://tornado-json.readthedocs.org/en/latest/using_tornado_json.html) in the documentation. And then [explore Tornado-JSON on readthedocs for the rest!](http://tornado-json.readthedocs.org/en/latest/index.html#)
Okay, but how do I install it?
For the possibly stable
` pip install Tornado-JSON `
For the latest and greatest
` git clone https://github.com/hfaran/Tornado-JSON.git cd Tornado-JSON sudo python setup.py install `
Neat, but `x` sucks, `y` is ugly, and `z` could be better.
You would be awesome for [opening an issue about it](https://github.com/hfaran/Tornado-JSON/issues/new), and I’ll promise my best to take a look.
You completely changed the interface in a recent update; what gives?
But newer is so much better! Seriously though, Tornado-JSON is, at the moment, still very much a work in progress. Updates will be made that will break the existing interface (and replace it with a shiny, new, much better one). All in the name of making it better! (And progress etc.)
## Running Tests
`bash sudo pip2 install tox sudo pip3 install tox sudo tox # Will run test matrix `
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.