Skip to main content

CometD client for asyncio

Project description

aiocometd

PyPI package Documentation Status Build status Coverage MIT license

aiocometd is a CometD client built using asyncio, implementing the Bayeux protocol.

CometD is a scalable WebSocket and HTTP based event and message routing bus. CometD makes use of WebSocket and HTTP push technologies known as Comet to provide low-latency data from the server to browsers and client applications.

Features

  • Supported transports:
    • long-polling

    • websocket

  • Automatic reconnection after network failures

  • Extensions

Usage

import asyncio

from aiocometd import Client

async def chat():
    nickname = "John"

    # connect to the server
    async with Client("http://example.com/cometd") as client:

            # subscribe to channels to receive chat messages and
            # notifications about new members
            await client.subscribe("/chat/demo")
            await client.subscribe("/members/demo")

            # send initial message
            await client.publish("/chat/demo", {
                "user": nickname,
                "membership": "join",
                "chat": nickname + " has joined"
            })
            # add the user to the chat room's members
            await client.publish("/service/members", {
                "user": nickname,
                "room": "/chat/demo"
            })

            # listen for incoming messages
            async for message in client:
                if message["channel"] == "/chat/demo":
                    data = message["data"]
                    print(f"{data['user']}: {data['chat']}")

if __name__ == "__main__":
    loop = asyncio.get_event_loop()
    loop.run_until_complete(chat())

Documentation

https://aiocometd.readthedocs.io/

Changelog

0.4.2 (2019-01-15)

  • Fix the handling of invalid websocket transport responses

  • Fix the handling of failed subscription responses

0.4.1 (2019-01-04)

  • Add documentation links

0.4.0 (2019-01-04)

  • Add type hints

  • Add integration tests

0.3.1 (2018-06-15)

  • Fix premature request timeout issue

0.3.0 (2018-05-04)

  • Enable the usage of third party JSON libraries

  • Fix detection and recovery from network failures

0.2.3 (2018-04-24)

  • Fix RST rendering issues

0.2.2 (2018-04-24)

  • Fix documentation typos

  • Improve examples

  • Reorganise documentation

0.2.1 (2018-04-21)

  • Add PyPI badge to README

0.2.0 (2018-04-21)

  • Supported transports:
    • long-polling

    • websocket

  • Automatic reconnection after network failures

  • Extensions

Project details


Download files

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

Source Distribution

aiocometd-0.4.2.tar.gz (51.5 kB view details)

Uploaded Source

Built Distribution

aiocometd-0.4.2-py3-none-any.whl (26.6 kB view details)

Uploaded Python 3

File details

Details for the file aiocometd-0.4.2.tar.gz.

File metadata

  • Download URL: aiocometd-0.4.2.tar.gz
  • Upload date:
  • Size: 51.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.0

File hashes

Hashes for aiocometd-0.4.2.tar.gz
Algorithm Hash digest
SHA256 20cec481486e129367f5662d6645a7e1405b59e6f3bb103e14c8c24cde6eacb9
MD5 88ba0e9ef3bbc812d1afbf50accc2f39
BLAKE2b-256 46e08e9ff83614ffb8548509aa9ccdfa8402a28aaeb68d9e3b2bbc77c8a53615

See more details on using hashes here.

File details

Details for the file aiocometd-0.4.2-py3-none-any.whl.

File metadata

  • Download URL: aiocometd-0.4.2-py3-none-any.whl
  • Upload date:
  • Size: 26.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.0

File hashes

Hashes for aiocometd-0.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 3d37418e417338cacb41f46b45863d52770db3dc19d02d1274a0deb2d20f51d9
MD5 64cb771c8216580041601a9bbcceedb1
BLAKE2b-256 0352d4ec0bcf95a592844f11e3f0709a6a41a679f00cca00429d2ead2a5c5716

See more details on using hashes here.

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