Skip to main content

A simple JSON API framework based on Tornado

Project description

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 <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?

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

Python2.7 and Python3.3 are supported.

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Tornado-JSON-0.40.tar.gz (11.0 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page