Release 0.9.1 Joshua Skelton, Felix Siebeneicker · twitch-observer Documentation, Release 0.9.1...

Preview:

Citation preview

twitch-observer DocumentationRelease 0.9.1

Joshua Skelton, Felix Siebeneicker

Jul 11, 2018

Contents:

1 Features 3

2 TwitchChatObserver 5

3 TwitchChatEvent 7

4 BadTwitchChatEvent 9

5 TwitchChatEventType 11

6 TwitchChatColor 13

7 Aliases 15

Python Module Index 17

i

ii

twitch-observer Documentation, Release 0.9.1

Turn Twitch chatter into Python events.

twitchobserver makes interacting with Twitch chat super easy. It is built and tuned for realtime applications. You canmake chatbots chat. You can build Twitch Plays video games.

Contents: 1

twitch-observer Documentation, Release 0.9.1

2 Contents:

CHAPTER 1

Features

• Pure Python: No extra dependencies. Just plain and simple Python.

• Small API: With a few classes and a handful of methods, you can learn it over a coffee break.

• Event Based: Makes writing apps easy and straightforward.

• Context Manager: Further simplifies working with observers.

3

twitch-observer Documentation, Release 0.9.1

4 Chapter 1. Features

CHAPTER 2

TwitchChatObserver

5

twitch-observer Documentation, Release 0.9.1

6 Chapter 2. TwitchChatObserver

CHAPTER 3

TwitchChatEvent

7

twitch-observer Documentation, Release 0.9.1

8 Chapter 3. TwitchChatEvent

CHAPTER 4

BadTwitchChatEvent

9

twitch-observer Documentation, Release 0.9.1

10 Chapter 4. BadTwitchChatEvent

CHAPTER 5

TwitchChatEventType

11

twitch-observer Documentation, Release 0.9.1

12 Chapter 5. TwitchChatEventType

CHAPTER 6

TwitchChatColor

13

twitch-observer Documentation, Release 0.9.1

14 Chapter 6. TwitchChatColor

CHAPTER 7

Aliases

There exist the following aliases:

class twitchobserver.Observer(nickname, password)Class for watching a Twitch channel. Creates events for various chat messages.

Parameters

• nickname – The user nickname to connect to the channel as

• password – The OAuth token to authenticate with

15

twitch-observer Documentation, Release 0.9.1

16 Chapter 7. Aliases

Python Module Index

ttwitchobserver, 15twitchobserver.twitchobserver, 3

17

twitch-observer Documentation, Release 0.9.1

18 Python Module Index

Index

OObserver (class in twitchobserver), 15

Ttwitchobserver (module), 15twitchobserver.twitchobserver (module), 3

19

Recommended