synchra.py 0.4.0

A modern, async-first Python SDK for the Synchra API v2.0.

Synchra Python SDK (v2.0)

A modern, async-first Python SDK for the Synchra API, providing robust access to channel management, real-time events, and multi-platform moderation.

Features

• Async Native: Built from the ground up for asyncio using aiohttp.
• Full Type Safety: Comprehensive Pydantic v2 models for all API resources and WebSocket events.
• WebSocket Client: Real-time event subscription and dispatcher with automatic reconnection.
• Provider Support: Specialized API groups for Twitch, YouTube, and Kick.
• OAuth2 Ready: Support for both manual access tokens and full OAuth2 refresh flows.

Installation

pip install synchra

Quick Start

HTTP API Client

import asyncio
from synchra import SynchraClient

async def main():
    # Initialize client (with token or OAuth credentials)
    client = SynchraClient(access_token="YOUR_ACCESS_TOKEN")
    
    # List channels
    channels = await client.channels.list()
    for channel in channels:
        print(f"Channel: {channel.display_name} ({channel.id})")
        
    # Get channel providers
    providers = await client.channels.list_providers(channels[0].id)
    for p in providers:
        print(f"Provider: {p.provider} ({p.provider_channel_name})")

    await client.close()

asyncio.run(main())

WebSocket Real-time Events

import asyncio
from synchra import SynchraClient

async def main():
    client = SynchraClient(access_token="YOUR_ACCESS_TOKEN")
    
    # Register an event handler
    @client.ws.on("activity")
    async def on_activity(event):
        data = event['data']
        print(f"[{event['type']}] New {data['type']} from {data['viewer_display_name']}")

    # Connect and subscribe
    await client.connect()
    await client.ws.subscribe("activity", channel_id="YOUR_CHANNEL_UUID")
    
    # Keep the client running
    try:
        while True:
            await asyncio.sleep(1)
    except KeyboardInterrupt:
        await client.close()

asyncio.run(main())

Development & Testing

The SDK includes a full test suite using pytest.

# Install dev dependencies
pip install "synchra[dev]"

# Run tests
python -m pytest tests/

API Groups

• client.channels: Main channel operations, provider listings, and Invite/Access Management.
• client.twitch: Twitch-specific features (Ban, Unban, Raid, Shoutout, Emulation).
• client.youtube: YouTube broadcasts and moderation.
• client.kick: Kick-specific moderation tools.
• client.user: Manage current user profile and linked accounts.
• client.chat: Send and broadcast chat messages across platforms.

Supported Platforms

• Twitch: Full moderation, raids, shoutouts, and EventSub emulation.
• YouTube: Broadcast management and moderation.
• Kick: Ban/Unban support.
• TikTok: Stream monitoring (experimental).
• Discord/Spotify: Integration support.

Invite & Access Management

Synchra v2.0 supports sophisticated member management for your channels:

from synchra import Synchra
from synchra.models import AccessLevel

# List current active invites
invites = await client.channels.list_invites(channel_id)

# Create a new Moderator invite
new_invite = await client.channels.create_invite(channel_id, access_level=AccessLevel.MOD)
print(f"Invite Link: {new_invite.invite_link}")

# List users who already have access
staff = await client.channels.list_user_access(channel_id)

# Upgrade a user to Admin
await client.channels.update_user_access(channel_id, staff[0].id, AccessLevel.ADMIN)

# Revoke an invite
await client.channels.delete_invite(channel_id, invites[0].id)

Documentation

For full API documentation and endpoint details, refer to the Synchra OpenAPI Spec.

License

MIT