twitch_auto_clipper

Automatically create Twitch clips when chat activity spikes.

Twitch Auto Clipper monitors Twitch chat and detects moments where a large number of viewers send the same emote/message within a short period of time. When activity exceeds a configurable threshold, it automatically creates a Twitch clip.

[demo]

Installation

pip install twitch_auto_clipper

Requirements

Minimum Python version supported by twitch_auto_clipper is 3.10.

Quick start

from twitch_auto_clipper_sqrtminusone.TwitchAutoClipper import TwitchAutoClipper

clipper = TwitchAutoClipper(
    ["Marlon", "Lacy"],
    "YOUR_CLIENT_ID",
    "YOUR_CLIENT_SECRET",
    on_clip=lambda clip: print(clip),
    common_value=1,
    emote_value=2,
    clipable_message_ratio=0.5,
)

clipper.start()
clipper.join()

[!IMPORTANT] client_id and client_secret are saved in TwitchAuthTokens and only sent to the Twitch API.

[!IMPORTANT] Upon initialization of TwitchAutoClipper, your web browser should open to gain clipping permission for your Twitch account (as shown in the demo).

Features

• Automatically handles Twitch OAuth token refresh
• Automatically monitors multiple Twitch streams
• Supports custom emotes/messages as clipping triggers
• Optional 7TV emote support
• Runs each streamer in separate thread

How it works

Twitch chat
     │
     ▼
Collect messages
     │
     ▼
Count messages / emotes
     │
     ▼
Detect activity spike
     │
     ▼
Threshold exceeded?
     │
    YES
     ▼
Create Twitch clip
     │
     ▼
Call on_clip callback

Usage

There are two classes that you will typically need:

• TwitchAutoClipper — monitors Twitch chat and automatically creates clips when a message reaches the configured threshold.
• Clip — contains information about a clip that was created.

TwitchAutoClipper

TwitchAutoClipper(
    streamers_names,
    client_id,
    client_secret,
    on_clip,
    counter_interval_seconds=...,
    clipable_message_ratio=...,
    clipable_wait=...,
    common_value=...,
    emote_value=...,
    excluded_words=...,
    logging_handlers=...,
    logging_level=...
)

[!NOTE] If multiple streamers are configured, on_clip may be called concurrently from multiple threads. Make sure your callback is thread-safe and use the appropriate Python threading APIs when necessary.

Clip

A Clip instance contains information about the clip that was created.

Motivation

Manually watching an entire stream to find moments worth clipping is time-consuming.

twitch_auto_clipper uses the audience's reaction as a signal: when chat suddenly becomes active around a particular message or emote, the bot can automatically capture the moment.

Roadmap

• Analyze Twitch chat through IRC
• Twitch OAuth authentication
• Automatically create clips
• Monitor multiple live streamers
• Save clips to a log
• Add automated tests
• Pip package
• Web page for constants editing