A framework to simplify tornado daemon development.
Project description
==========
os-tornado
==========
.. image:: https://travis-ci.org/cfhamlet/os-tornado.svg?branch=master
:target: https://travis-ci.org/cfhamlet/os-tornado
.. image:: https://codecov.io/gh/cfhamlet/os-tornado/branch/master/graph/badge.svg
:target: https://codecov.io/gh/cfhamlet/os-tornado
A framework to organize tornado project and simplify development.
Requirements
-------------
* Python2.7
* Works on Linux
Install
-------
``pip install os-tornado``
Usage
------
* Create project
``os-tornado startproject new_project``
Will create a project structure::
new_project/
├── app
│ ├── extensions
│ │ ├── example_extension.py
│ │ ├── __init__.py
│ ├── request_handlers
│ │ ├── example_handler.py
│ │ ├── __init__.py
│ ├── __init__.py
│ ├── settings.py
└── manager.py
* Write your extensions and request handlers
* Extension
You can implement ``setup``, ``run``, ``cleanup`` as your need.
* Request handler
See `tornado.web — RequestHandler and Application classes <http://www.tornadoweb.org/en/stable/web.html>`_
You can get extension inside request handler:
``self.application.manager.get_extenion(extension_name)``
* Configure settings (app/settings.py)
You can set tornado inner app settings and server settings with specified PREFIX:
* TORNADO_APP_SETTINGS_
* TORNADO_SERVER_SETTINGS_
example:
``TORNADO_APP_SETTINGS_DEBUG = True``
* Run server
``python manager runserver``
Advanced Usage
--------------
* ``os_tornado.decorators.jsonify``
jsonify returned dict and raised HTTPError
example:
.. code-block:: python
@jsonify
class ExampleHandler(RequestHandler):
def get(self, *args, **kwargs):
return {'status':'ok'}
def post(self, *args, **kwargs):
raise HTTPHandler(404)
Unit Tests
----------
``$ tox``
License
--------
MIT licensed.
os-tornado
==========
.. image:: https://travis-ci.org/cfhamlet/os-tornado.svg?branch=master
:target: https://travis-ci.org/cfhamlet/os-tornado
.. image:: https://codecov.io/gh/cfhamlet/os-tornado/branch/master/graph/badge.svg
:target: https://codecov.io/gh/cfhamlet/os-tornado
A framework to organize tornado project and simplify development.
Requirements
-------------
* Python2.7
* Works on Linux
Install
-------
``pip install os-tornado``
Usage
------
* Create project
``os-tornado startproject new_project``
Will create a project structure::
new_project/
├── app
│ ├── extensions
│ │ ├── example_extension.py
│ │ ├── __init__.py
│ ├── request_handlers
│ │ ├── example_handler.py
│ │ ├── __init__.py
│ ├── __init__.py
│ ├── settings.py
└── manager.py
* Write your extensions and request handlers
* Extension
You can implement ``setup``, ``run``, ``cleanup`` as your need.
* Request handler
See `tornado.web — RequestHandler and Application classes <http://www.tornadoweb.org/en/stable/web.html>`_
You can get extension inside request handler:
``self.application.manager.get_extenion(extension_name)``
* Configure settings (app/settings.py)
You can set tornado inner app settings and server settings with specified PREFIX:
* TORNADO_APP_SETTINGS_
* TORNADO_SERVER_SETTINGS_
example:
``TORNADO_APP_SETTINGS_DEBUG = True``
* Run server
``python manager runserver``
Advanced Usage
--------------
* ``os_tornado.decorators.jsonify``
jsonify returned dict and raised HTTPError
example:
.. code-block:: python
@jsonify
class ExampleHandler(RequestHandler):
def get(self, *args, **kwargs):
return {'status':'ok'}
def post(self, *args, **kwargs):
raise HTTPHandler(404)
Unit Tests
----------
``$ tox``
License
--------
MIT licensed.
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.
Source Distribution
os-tornado-0.1.6.tar.gz
(17.8 kB
view hashes)