pystreamerbot

Python client for interacting with the Streamer.bot WebSocket API.

Installation

pip install -U pystreamerbot

Basic Usage

import asyncio
from typing import Any

from pystreamerbot import Client

client = Client(events="Twitch.ChatMessage")

@client.event
async def on_ready() -> None:
    print(f"Streamer.bot WebSocket ({client.ws.id}) is ready!")

@client.event
async def on_twitch_chatmessage(data: dict[str, Any]) -> None:
    username = data.get("user", {}).get("name", "Unknown")
    print(f"Hello, {username}!")

async def main() -> None:
    await client.listen()

if __name__ == "__main__":
    asyncio.run(main())

You can find more examples in the examples directory or alternatively you can look into the documentation.

Attribution

Thank you to:

• nate1280 for creating Streamer.bot.
• Whipstickgostop for creating the official TypeScript client for Streamer.bot.
• Rapptz & the discord.py team for creating the architecture and design that inspired this library.

Contributing

Thanks for your interest in contributing! We welcome contributions of all kinds, including bug fixes, new features, and documentation improvements.

By contributing to this repository, you agree to follow our Contributing Guidelines and Code of Conduct.

Getting Started

You can either fork or manually clone it by doing the following:

git clone https://github.com/miichom/pystreamerbot.git
cd pystreamerbot

This package uses Hatch for its development, you can install it by running pip install hatch in your terminal.

# Creates a new hatch environment
hatch env create dev

# Avaliable hatch scripts
hatch run dev:lint
hatch run dev:test
hatch run dev:types

License

pystreamerbot is distributed under the terms of the MIT license.