Skip to main content

Makes handling websockets with Mongrel2 and Python easy peasy.

This module was lovingly crafted for First Opinion.

Example

Typical websocket hello world type example, creating an echo server:

import os
import logging

logging.basicConfig()
rl = logging.getLogger()
rl.setLevel('DEBUG')

from m2websocket import Connection


conn = Connection("tcp://localhost:port", "tcp://localhost:port")

while True:
    req = conn.recv()
    if req.is_handshake():
        conn.reply_handshake(req)

    else:
        conn.reply_websocket(req, req.body, req.opcode)

Yup, that’s all there is to it, much easier than this example.

You can see a working example of the echo server (with a working mongrel2 conf file and python script) by looking in the example/ directory in the Github repo.

Install it

Prerequisites

You’ll need to install the mongrel2 python library from the mongrel2 source. Once you’ve cloned the source or downloaded that folder, you can install it using setup.py

$ cd /path/to/mongrel2/src/examples/python
$ python setup.py install

Then, you can install this module using pip:

pip install m2websocket

Or:

pip install git+https://github.com/firstopinion/m2websocket#egg=m2websocket

Tests are actually kind of hard to run, you need to install mongrel2 and have it load the example/mongrel2.conf configuration and then run the example/echo.py server. You also need to pip install websocket-client.

License

MIT

Release files for m2websocket 0.2.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for m2websocket 0.2.2
File Size Uploaded
m2websocket-0.2.2.tar.gz 6.0 kB Details

Release files / m2websocket-0.2.2.tar.gz

Download URL m2websocket-0.2.2.tar.gz
Size 6.0 kB
Tags Source
SHA-256 checksum
How to use checksums
adbb9342d4047a9666c1b6eecae7baef9fa5385b1af5d5287fcb0cc9d65f020e
BLAKE2b-256 checksum
How to use checksums
ecf1c5bc65d9a071d9dfce65f2f86e55f5a1a83877227f9cd00a9fb1ae65ea72
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.2.2 This release

1 release file

0.2.1

1 release file

0.2

1 release file

0.1.9

1 release file

0.1.8

1 release file

0.1.7

1 release file

0.1.6

1 release file

0.1.5

1 release file

0.1.2

1 release file

0.1.1

1 release file

0.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page