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

Official repository for gevent-socketio
https://github.com/abourget/gevent-socketio

Last synced: about 1 month ago
JSON representation

Official repository for gevent-socketio

• Host: GitHub
• URL: https://github.com/abourget/gevent-socketio
• Owner: abourget
• License: bsd-3-clause
• Created: 2012-01-11T15:18:14.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2022-09-17T20:57:58.000Z (about 2 years ago)
• Last Synced: 2024-04-14T13:10:26.678Z (7 months ago)
• Language: JavaScript
• Homepage: http://readthedocs.org/docs/gevent-socketio/en/latest/
• Size: 1.95 MB
• Stars: 1,214
• Watchers: 74
• Forks: 337
• Open Issues: 108
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG
  • License: LICENSE

Awesome Lists containing this project

• awesome-pyramid - gevent-socketio - (Async)

README

        
Presentation

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

.. image:: https://secure.travis-ci.org/abourget/gevent-socketio.png?branch=master

``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``.

Community, rise up!

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

ANNOUNCEMENT: This project is in need of a solid maintainer to navigate through the 27+ open Pull Requests, merge what needs to be merged, and continue on with newer developments. @abourget is not putting as much time as he'd like on this project these days.  This project has nearly 1000 GitHub Stars.. it's used by major corporations. It's a great project for you to lead. Contact me on Twitter @bourgetalexndre to take more leadership.

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

To execute all tests, run:

    tox

To execute all tests for a specific Python version, run something like:

    tox -e py27

    

To execute a specific test for a specific Python version, run something like:

    tox -e py27 -- test_packet.py::TestEncodeMessage::test_encode_event