https://github.com/bugthesystem/socket.io-python-emitter

Python implementation of socket.io-emitter that provides a hook point to easily allow you to emit events to browsers from anywhere :rocket:
https://github.com/bugthesystem/socket.io-python-emitter

pip python redis socket-io socketio

Last synced: about 1 month ago
JSON representation

Python implementation of socket.io-emitter that provides a hook point to easily allow you to emit events to browsers from anywhere :rocket:

• Host: GitHub
• URL: https://github.com/bugthesystem/socket.io-python-emitter
• Owner: bugthesystem
• License: unlicense
• Created: 2014-05-31T00:24:48.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2018-07-13T13:09:09.000Z (about 6 years ago)
• Last Synced: 2024-07-20T06:06:38.903Z (about 2 months ago)
• Topics: pip, python, redis, socket-io, socketio
• Language: Python
• Homepage:
• Size: 45.9 KB
• Stars: 74
• Watchers: 5
• Forks: 22
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst
  • License: COPYING

Awesome Lists containing this project

README

        
socket.io-python-emitter

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

.. image:: https://travis-ci.org/ziyasal/socket.io-python-emitter.svg?branch=master

    :target: https://travis-ci.org/ziyasal/socket.io-python-emitter

.. image:: https://img.shields.io/pypi/v/socket.io-emitter.svg

    :target: https://pypi.org/project/socket.io-emitter/

.. image:: https://codecov.io/gh/ziyasal/socket.io-python-emitter/branch/master/graph/badge.svg

    :target: https://codecov.io/gh/ziyasal/socket.io-python-emitter

A Python implementation of `socket.io-emitter `_.

`socket.io `_ provides a hook point to easily allow you to emit events to browsers from anywhere so `socket.io-python-emitter` communicates with `socket.io `_ servers through redis.

We made some changes, compatible socket.io-redis 0.2.0 and socket.io 0.1.4.

How to use

----------

**Install via pip**

  

  pip install socket.io-emitter

.. code-block:: python

  from socket_io_emitter import Emitter

  io=Emitter({'host': 'localhost', 'port':6379})

  io.Emit('broadcast event','Hello from socket.io-python-emitter')

API

---

Emitter(opts)

-------------

The following options are allowed:

- `client`: is a `redis-py `_ compatible client

   This argument is optional.

- `key`: the name of the key to pub/sub events on as prefix (`socket.io`)

- `host`: host to connect to redis on (`localhost`)

- `port`: port to connect to redis on (`6379`)

If you don't want to supply a redis client object, and want

`socket.io-python-emitter` to initialize one for you, make sure to supply the

`host` and `port` options.

Specifies a specific `room` that you want to emit to.

Emitter#In(room):Emitter

------------------------

.. code-block:: python

  io=Emitter({'host': 'localhost', 'port':6379})

  io.In("room-name").Emit("news","Hello from python emitter");

Emitter#To(room):Emitter

------------------------

.. code-block:: python

  io=Emitter({'host': 'localhost', 'port':6379})

    

  io.To("room-name").Emit("news","Hello from python emitter");

We are flattening the room parameter from `[]` and `*argv`, so you can also send to several rooms like this (both examples are valid).

.. code-block:: python

  io=Emitter({'host': 'localhost', 'port':6379})

  io.To(["room1", "room2"]).Emit("news","Hello from python emitter");

  io.To("room1", "room2").Emit("news","Hello from python emitter");

Emitter#Of(namespace):Emitter

-----------------------------

Specifies a specific namespace that you want to emit to.

.. code-block:: python

  io=Emitter({'host': 'localhost', 'port':6379})

    

  io.Of("/nsp").In("room-name").Emit("news","Hello from python emitter");

Open Source Projects in Use

---------------------------

* `redis-py `_ by Andy McCurdy @andymccurdy

* `msgpack-python `_ by MessagePack

@ziλasal & @abdullahselek