Metadata-Version: 1.1
Name: Tornado-JSON
Version: 1.3.4
Summary: A simple JSON API framework based on Tornado
Home-page: https://github.com/hfaran/Tornado-JSON
Author: Hamza Faran
Author-email: UNKNOWN
License: MIT License
Description: # Tornado-JSON
        
        [![Join the chat at https://gitter.im/hfaran/Tornado-JSON](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/hfaran/Tornado-JSON?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
        
        [![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://img.shields.io/pypi/v/Tornado-JSON.svg)](https://pypi.python.org/pypi/Tornado-JSON/)
        [![Supported Python versions](https://img.shields.io/pypi/pyversions/Tornado-JSON.svg)](https://pypi.python.org/pypi/Tornado-JSON/)
        [![Development Status](https://img.shields.io/pypi/status/Tornado-JSON.svg)](https://pypi.python.org/pypi/Tornado-JSON/)
        [![Download format](https://img.shields.io/pypi/format/Tornado-JSON.svg)](https://pypi.python.org/pypi/Tornado-JSON/)
        [![License](https://img.shields.io/pypi/l/Tornado-JSON.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
        
        
        ## Usage
        
        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#)
        
        ```python
        import tornado.ioloop
        from tornado_json.routes import get_routes
        from tornado_json.application import Application
        
        import mywebapp
        
        
         # Automatically generate routes for your webapp
        routes = get_routes(mywebapp)
        # Create and start application
        application = Application(routes=routes, settings={})
        application.listen(8888)
        tornado.ioloop.IOLoop.instance().start()
        ```
        
        ### Example Projects That Use Tornado-JSON
        
        * https://github.com/hfaran/CitySportsLeague-Server
        * https://github.com/hfaran/LivesPool
        
        
        ## Installation
        
        * For the possibly stable
        
        ```bash
        pip install Tornado-JSON
        ```
        
        * For the latest and greatest
        
        ```bash
        git clone https://github.com/hfaran/Tornado-JSON.git
        cd Tornado-JSON
        python setup.py develop
        ```
        
        
        ## Contributing
        
        If there is something you would like to see improved, 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.
        
        Pull requests are absolutely welcome as well!
        
        
        ## License
        
        This project is licensed under the MIT License.
        
        
        ## Running Tests
        
        ```bash
        sudo pip2 install tox
        sudo pip3 install tox
        tox  # Will run test matrix
        ```
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
