Skip to content

Deiru2k/Tornado-JSON

 
 

Repository files navigation

Tornado-JSON

Build Status PyPI version Coverage Status Stories in Ready

Overview

Tornado-JSON is a small extension of Tornado 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 validation by decorating RequestHandlers with @schema.validate
  • Automated route generation with routes.get_routes(package)
  • Automated GFM-formatted API documentation using schemas and provided descriptions
  • Standardized JSON output using the JSend specification

Getting Started/FAQ

How do I use this thing?

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 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.)

Dependencies

Python{2.7, 3.3, 3.4} are supported.

These dependencies can be satisfied by running pip install -r requirements.txt

About

A simple JSON API framework based on Tornado

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 91.6%
  • Shell 8.4%