metricsfirst 0.1.0

MetricsFirst SDK for Python - Analytics for Telegram bots

MetricsFirst Python SDK

Official Python SDK for MetricsFirst - Analytics for Telegram bots.

Installation

# Basic installation (sync only)
pip install metricsfirst

# With async support
pip install metricsfirst[async]

# With aiogram middleware
pip install metricsfirst[aiogram]

# Everything
pip install metricsfirst[all]

Quick Start

Synchronous Client

from metricsfirst import MetricsFirst, CommandEventData, ServiceEventData

# Initialize
mf = MetricsFirst(
    bot_id="your_bot_id",
    api_key="your_api_key",
)

# Track a command
mf.track_command(CommandEventData(
    user_id=123456789,
    command="/start",
    response_time_ms=150,
))

# Track a service
mf.track_service(ServiceEventData(
    user_id=123456789,
    service_name="image_generation",
    is_free=False,
    price=10,
    currency="USD",
))

# Don't forget to shutdown
mf.shutdown()

Asynchronous Client

import asyncio
from metricsfirst import AsyncMetricsFirst, CommandEventData

async def main():
    # Initialize
    mf = AsyncMetricsFirst(
        bot_id="your_bot_id",
        api_key="your_api_key",
    )
    await mf.start()

    # Track events
    await mf.track_command(CommandEventData(
        user_id=123456789,
        command="/start",
    ))

    # Shutdown
    await mf.shutdown()

asyncio.run(main())

Context Manager

# Sync
with MetricsFirst(bot_id="...", api_key="...") as mf:
    mf.track_command(...)

# Async
async with AsyncMetricsFirst(bot_id="...", api_key="...") as mf:
    await mf.track_command(...)

Aiogram Integration

from aiogram import Bot, Dispatcher, Router
from aiogram.types import Message
from metricsfirst import AsyncMetricsFirst
from metricsfirst.middleware import create_aiogram_middleware

bot = Bot(token="BOT_TOKEN")
dp = Dispatcher()
router = Router()

# Initialize MetricsFirst
mf = AsyncMetricsFirst(bot_id="your_bot_id", api_key="your_api_key")

# Add middleware - automatically tracks all commands and interactions
middleware = create_aiogram_middleware(mf)
router.message.middleware(middleware)
router.callback_query.middleware(middleware)

@router.message(commands=["start"])
async def start_handler(message: Message):
    await message.answer("Hello!")

dp.include_router(router)

async def main():
    await mf.start()
    try:
        await dp.start_polling(bot)
    finally:
        await mf.shutdown()

Using Decorators

from metricsfirst import AsyncMetricsFirst
from metricsfirst.middleware import async_track_command, async_track_service

mf = AsyncMetricsFirst(bot_id="...", api_key="...")

@async_track_command(mf, lambda msg: msg.from_user.id)
async def start_handler(message):
    await message.answer("Hello!")

@async_track_service(mf, "download", lambda msg: msg.from_user.id, is_free=False, price=5)
async def download_handler(message):
    # Your download logic
    pass

Available Events

Method	Description
track_command()	Track bot commands
track_interaction()	Track user interactions
track_service()	Track services provided
track_error()	Track errors
track_error_from_exception()	Track error from exception
track_purchase_initiated()	Track purchase start
track_purchase_completed()	Track successful purchase
track_purchase_error()	Track failed purchase
track_recurring_charge_success()	Track subscription charge
track_recurring_charge_failed()	Track failed charge
identify()	Identify user with properties

Configuration

mf = MetricsFirst(
    bot_id="your_bot_id",
    api_key="your_api_key",
    api_url="https://api.metricsfirst.com",  # Custom API URL
    batch_events=True,      # Batch events before sending
    batch_size=10,          # Events per batch
    batch_interval=5.0,     # Seconds between flushes
    debug=False,            # Enable debug logging
    timeout=10.0,           # HTTP timeout
)

License

MIT