https://github.com/philipn/gevent-socketio

Fork of the official repository for gevent-socketio.
https://github.com/philipn/gevent-socketio

Last synced: 3 months ago
JSON representation

Fork of the official repository for gevent-socketio.

• Host: GitHub
• URL: https://github.com/philipn/gevent-socketio
• Owner: philipn
• License: bsd-3-clause
• Fork: true (abourget/gevent-socketio)
• Created: 2012-04-09T00:22:40.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2012-08-01T20:40:56.000Z (over 12 years ago)
• Last Synced: 2024-06-22T22:03:38.070Z (6 months ago)
• Language: JavaScript
• Homepage: http://readthedocs.org/docs/gevent-socketio/en/latest/
• Size: 1.15 MB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG
  • License: LICENSE

Awesome Lists containing this project

README

        
Presentation

============

``gevent-socketio`` is a Python implementation of the Socket.IO

protocol, developed originally for Node.js by LearnBoost and then

ported to other languages.  Socket.IO enables real-time web

communications between a browser and a server, using a WebSocket-like

API.  One aim of this project is to provide a single ``gevent``-based

API that works across the different WSGI-based web frameworks out

there (Pyramid, Pylons, Flask, web2py, Django, etc...).  Only ~3 lines

of code are required to tie-in ``gevent-socketio`` in your framework.

Note: you need to use the ``gevent`` python WSGI server to use

``gevent-socketio``.

Technical overview

==================

Most of the ``gevent-socketio`` implementation is pure Python.  There

is an obvious dependency on ``gevent``, and another on

``gevent-websocket``.  There are integration examples for Pyramid, Flask,

Django and BYOF (bring your own framework!).

Documentation and References

============================

You can read the renderered Sphinx docs at:

* http://readthedocs.org/docs/gevent-socketio/en/latest/

Discussion and questions happen on the mailing list:

* https://groups.google.com/forum/#!forum/gevent-socketio

or in the Github issue tracking:

* https://github.com/abourget/gevent-socketio/issues

You can also contact the maintainer:

* https://twitter.com/#!/bourgetalexndre

* https://plus.google.com/109333785244622657612

Installation

============

You can install with standard Python methods::

   pip install gevent-socketio

or from source::

   git clone git://github.com/abourget/gevent-socketio.git

   cd gevent-socketio

   python setup.py install

For development, run instead of ``install``::

   python setup.py develop

If you want to do all of that in a virtualenv, run::

   virtualenv env

   . env/bin/activate

   python setup.py develop   # or install