Skip to main content

SockJs for Flask

Project description

SockJS server for Flask
============

.. image:: https://img.shields.io/pypi/v/sockjs-flask.svg
:target: https://pypi.python.org/pypi/sockjs-flask
:alt: Latest PyPI version

.. image:: https://travis-ci.org/borntyping/cookiecutter-pypackage-minimal.png
:target: https://travis-ci.org/borntyping/cookiecutter-pypackage-minimal
:alt: Latest Travis CI build status

`sockjs` is a `SockJS <http://sockjs.org>`_ integration for Flask. SockJS interface
is implemented as a flask route. Its possible to create any number of different sockjs routes, ie `/sockjs/*` or `/mycustom-sockjs/*`.
You can provide different session implementation and management for each sockjs route.

Usage
-----

Client side code::

<script src="//cdnjs.cloudflare.com/ajax/libs/sockjs-client/1.1.4/sockjs.js"></script>
<script>
var sock = new SockJS('http://localhost:5000/sockjs');

sock.onopen = function() {
console.log('open');
};

sock.onmessage = function(obj) {
console.log(obj);
};

sock.onclose = function() {
console.log('close');
};
</script>


Installation
------------
1. Install virtualenv::

$ wget https://raw.github.com/pypa/virtualenv/master/virtualenv.py
$ python3.6 ./virtualenv.py --no-site-packages sockjs

3. Install sockjs-flask from pypi and then install::

$ pip install sockjs-flask
$ cd sockjs
$ ../sockjs/bin/python setup.py

To run chat example use following command::

$ ./sockjs/bin/python ./sockjs-flask/examples/main.py

Requirements
^^^^^^^^^^^^

- Python >= 3.4
- gunicorn
- gevent
- gevent-websocket
- kombu (for subscription)

Authors
-------

`sockjs-flask` was written by `Kryuchkov Nikita <pycodi@hotmail.com>`_.

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

sockjs-flask-0.3.tar.gz (17.7 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page