Skip to main content

Engine.IO server

Project description

https://travis-ci.org/miguelgrinberg/python-engineio.svg?branch=master

Python implementation of the Engine.IO realtime server.

Features

  • Fully compatible with the Javascript engine.io-client library, versions 1.5.0 and up.

  • Compatible with Python 2.7 and Python 3.3+.

  • Supports large number of clients even on modest hardware when used with an asynchronous server based on asyncio (sanic, aiohttp or tornado), eventlet or gevent. For development and testing, any WSGI compliant multi-threaded server can be used.

  • Includes a WSGI middleware that integrates Engine.IO traffic with standard WSGI applications.

  • Uses an event-based architecture implemented with decorators that hides the details of the protocol.

  • Implements HTTP long-polling and WebSocket transports.

  • Supports XHR2 and XHR browsers as clients.

  • Supports text and binary messages.

  • Supports gzip and deflate HTTP compression.

  • Configurable CORS responses to avoid cross-origin problems with browsers.

Examples

The following application uses the Eventlet asynchronous server, and includes a small Flask application that serves the HTML/Javascript to the client:

import engineio
import eventlet
import eventlet.wsgi
from flask import Flask, render_template

eio = engineio.Server()
app = Flask(__name__)

@app.route('/')
def index():
    """Serve the client-side application."""
    return render_template('index.html')

@eio.on('connect')
def connect(sid, environ):
    print("connect ", sid)

@eio.on('message')
def message(sid, data):
    print("message ", data)
    eio.send(sid, 'reply')

@eio.on('disconnect')
def disconnect(sid):
    print('disconnect ', sid)

if __name__ == '__main__':
    # wrap Flask application with engineio's middleware
    app = engineio.Middleware(eio, app)

    # deploy as an eventlet WSGI server
    eventlet.wsgi.server(eventlet.listen(('', 8000)), app)

And below is a similar example, coded for asyncio (Python 3.5+ only) with the aiohttp framework:

from aiohttp import web
import engineio

eio = engineio.AsyncServer()
app = web.Application()
eio.attach(app)

async def index(request):
    """Serve the client-side application."""
    with open('index.html') as f:
        return web.Response(text=f.read(), content_type='text/html')

@eio.on('connect')
def connect(sid, environ):
    print("connect ", sid)

@eio.on('message')
async def message(sid, data):
    print("message ", data)
    await eio.send(sid, 'reply')

@eio.on('disconnect')
def disconnect(sid):
    print('disconnect ', sid)

app.router.add_static('/static', 'static')
app.router.add_get('/', index)

if __name__ == '__main__':
    web.run_app(app)

Resources

Project details


Release history Release notifications | RSS feed

This version

2.3.2

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

python-engineio-2.3.2.tar.gz (24.6 kB view details)

Uploaded Source

Built Distribution

python_engineio-2.3.2-py2.py3-none-any.whl (30.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file python-engineio-2.3.2.tar.gz.

File metadata

  • Download URL: python-engineio-2.3.2.tar.gz
  • Upload date:
  • Size: 24.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.7.0

File hashes

Hashes for python-engineio-2.3.2.tar.gz
Algorithm Hash digest
SHA256 871f4d022eb9171e380281266ba2aef0759b264ba862350bc94e7a597a98a443
MD5 92d2e1b62083ce8f0dcd8fd905b0dd9d
BLAKE2b-256 661809516793c68e0f7fb759d54c109a09a86e31c3e685eb77884613a1c1a7b3

See more details on using hashes here.

Provenance

File details

Details for the file python_engineio-2.3.2-py2.py3-none-any.whl.

File metadata

  • Download URL: python_engineio-2.3.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 30.8 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.7.0

File hashes

Hashes for python_engineio-2.3.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 306a91fda59e3678b34755f475ff6b5b3dc0deb0272a23e213f2f259b5602c4c
MD5 b269266fa4f284f4aa151635ea550cc8
BLAKE2b-256 036e44dea849953c21004e288f64d784822c18df25aa043855d87cc1f63c4b41

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page