/Stickney

I hate epoll! I hate epoll!

Primary LanguagePythonGNU Lesser General Public License v3.0LGPL-3.0

Stickney

PyPI - Version

Stickney is an asynchronous websockets library for AnyIO and Python 3.11+. This is primarily designed for Trio (as asyncio is a bastard evil terrible library that deadlocks constantly) usage.

Installation

Stickney is available on PyPI.

$ poetry add stickney@latest

Usage

Create a new websocket with the open_ws_connection function:

async with open_ws_connection(url="wss://example.websocket.server/path?a=b") as ws:
    ...

You can send messages with the send_message function and receive messages with the receive_single_message function. You can also use close, but the WS is closed automatically when the context manager exits.

There's not really much else to it. See stickney/frames.py for the available message types.

Naming

Stickney is named after the Stickney crater on Phobos.