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


Release history Release notifications

History Node

1.3.2

History Node

1.3.1

History Node

1.3.0

History Node

1.2.2

History Node

1.2.1

History Node

1.2.0

History Node

1.1.0

History Node

1.0.1

History Node

1.0.0

History Node

0.41

History Node

0.40

History Node

0.31

This version
History Node

0.30

History Node

0.20

History Node

0.14

History Node

0.13

History Node

0.12

History Node

0.11

History Node

0.10

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
Tornado-JSON-0.30.tar.gz (10.7 kB) Copy SHA256 hash SHA256 Source None Feb 23, 2014

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page