aiosfstream 0.5.0

Features

• Supported authentication types:

  • using a username and password

  • using a refresh token

• Subscribe to and receive messages on:

  • PushTopics

  • Generic Streaming Channels

  • Platform Events

  • Change Data Capture events

• Support for durable messages and replay of events

• Automatic recovery from replay errors

Usage

import asyncio

from aiosfstream import SalesforceStreamingClient


async def stream_events():
    # connect to Streaming API
    async with SalesforceStreamingClient(
            consumer_key="<consumer key>",
            consumer_secret="<consumer secret>",
            username="<username>",
            password="<password>") as client:

        # subscribe to topics
        await client.subscribe("/topic/one")
        await client.subscribe("/topic/two")

        # listen for incoming messages
        async for message in client:
            topic = message["channel"]
            data = message["data"]
            print(f"{topic}: {data}")

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

Documentation

http://aiosfstream.readthedocs.io/

0.5.0 (2019-03-08)

• Add support for Change Data Capture events

• Fix some typos in the documentation

0.4.0 (2019-01-06)

• Add type hints

• Configurable replay storage behavior

0.3.0 (2018-11-07)

• Add support for sandbox orgs

0.2.5 (2018-11-06)

• Add missing changelog entries

0.2.4 (2018-11-06)

• Fix platform event message creation date extraction issue

0.2.3 (2018-09-19)

• Fix asynchronous iterator bug in python 3.7

0.2.2 (2018-06-15)

• Update aiocometd dependency to 0.3.1

0.2.1 (2018-05-25)

• Fix replay issues on mass record delete operations

• Improve the documentation of the Client.publish method

0.2.0 (2018-05-05)

• Enable the usage of third party JSON libraries

• Expose authentication results as public attributes in Authenticator classes

0.1.0 (2018-04-26)

• Supported authentication types:

  • using a username and password

  • using a refresh token

• Subscribe to and receive messages on:

  • PushTopics

  • Generic Streaming Channels

• Support for durable messages and replay of events

• Automatic recovery from replay errors