tldr-common 2.0.5

Shared utilities and models for TL;DR.tv platform

Common Module

Shared utilities and models for the TL;DR.tv platform.

Structure

common/
├── src/common/
│   ├── core/          # Core functionality (config, exceptions, dependencies)
│   ├── dao/           # Data Access Objects
│   ├── database/      # Database connectivity
│   ├── logging/       # Logging configuration
│   ├── message/       # Message queue models
│   ├── models/        # Domain models
│   ├── platform/      # Platform-specific APIs (Twitch, Kick)
│   └── utils/         # Utility functions
└── tests/
    ├── unit/          # Unit tests
    └── integration/   # Integration tests

Installation

The common module is part of the uv workspace and is automatically available to other services.

For development:

uv pip install -e common

Usage

Data Access Objects (DAOs)

from common.dao import UserDAO, StreamDAO, ClipDAO
from common.database import Db, DBConfig

# Initialize database
db = Db(DBConfig())

# Create DAOs
user_dao = UserDAO(db)
stream_dao = StreamDAO(db)
clip_dao = ClipDAO(db)

Platform APIs

from common.platform.twitch import TwitchApi, TwitchApiConfig
from common.platform.kick import KickApi, KickApiConfig

# Initialize APIs
twitch_api = TwitchApi(config=TwitchApiConfig())
kick_api = KickApi(config=KickApiConfig())

Message Models

from common.message import StreamOnlineMessage, StreamOfflineMessage

# Create messages for RabbitMQ
message = StreamOnlineMessage(
    stream_id="12345",
    user_id=67890,
    platform="twitch",
    started_at=datetime.now()
)

Exception Handling

from common.core.exceptions import (
    DatabaseError,
    TwitchError,
    KickError,
    ValidationError,
    RateLimitError
)

try:
    # Database operation
    user = await user_dao.get_user_by_id(user_id)
except DatabaseError as e:
    logger.error(f"Database error: {e}")

Testing

Run all tests:

uv run pytest common/tests/

Run unit tests only:

uv run pytest common/tests/unit/

Run integration tests:

uv run pytest common/tests/integration/

Type Checking

The module includes type information (py.typed). Run type checking with:

uv run ty check common/