Skip to main content

Official analytics SDK for Discord bots using Cordia

Project description

Cordia

The official Python analytics SDK for Discord bots.

Async-first design built on aiohttp. Tracks commands, users, server count, and uptime with automatic batching and background heartbeat.

PyPI License: MIT

Install

pip install cordia

Requires Python 3.8+.

Quick Start

import cordia
import os

# pass your discord.py bot/client instance
client = cordia.CordiaClient(
    api_key=os.getenv("CORDIA_API_KEY"),
    bot=bot,  # bot_id auto-detected from bot.user.id
)

Discord.py Example

import discord
from discord.ext import commands
import cordia
import os

intents = discord.Intents.default()
intents.message_content = True
bot = commands.Bot(command_prefix="!", intents=intents)

cordia_client = cordia.CordiaClient(
    api_key=os.getenv("CORDIA_API_KEY"),
    bot=bot,  # bot_id + shard metadata auto-detected
)

@bot.event
async def on_ready():
    print(f"Logged in as {bot.user}")
    await cordia_client.post_guild_count(len(bot.guilds))
    cordia_client.start(bot.loop)

@bot.command()
async def ping(ctx):
    await ctx.send("Pong!")
    await cordia_client.track_command(
        command="ping",
        user_id=str(ctx.author.id),
        guild_id=str(ctx.guild.id) if ctx.guild else None,
    )

bot.run(os.getenv("DISCORD_TOKEN"))

Configuration

Parameter Type Default Description
api_key str required API key from the Cordia dashboard
bot discord.Client recommended Discord.py bot/client for bot_id + shard auto-detection
bot_id str optional Manual bot ID override (rarely needed)
heartbeat_interval int 30000 Heartbeat interval (ms)
auto_heartbeat bool True Start heartbeat on start()
batch_size int 10 Events before auto-flush
flush_interval int 5000 Auto-flush interval (ms)
debug bool False Enable debug logging

API

Method Description
start(loop) Start background tasks (flush + heartbeat)
track_command(...) Queue a command event
track_user(...) Queue a user activity event
post_guild_count(count) Report server count (immediate)
start_heartbeat(loop) Start heartbeat manually
stop_heartbeat() Stop heartbeat
get_uptime() Returns uptime in ms
flush() Force-flush queued events
close() Stop tasks, flush, and close session

Documentation

Full guides and API reference at docs.cordialane.com.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cordia-1.2.3.tar.gz (8.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cordia-1.2.3-py3-none-any.whl (8.1 kB view details)

Uploaded Python 3

File details

Details for the file cordia-1.2.3.tar.gz.

File metadata

  • Download URL: cordia-1.2.3.tar.gz
  • Upload date:
  • Size: 8.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for cordia-1.2.3.tar.gz
Algorithm Hash digest
SHA256 2138fed632f2046576fece635a76a2f2c4adf19d6fecbd16ef726041900a676c
MD5 1394c14ff9c6a3fcd0641e6f937fba6d
BLAKE2b-256 81fc96fac29b7ee0146b5db3d438b489c567b491cb5474672a86edfc98ef898f

See more details on using hashes here.

File details

Details for the file cordia-1.2.3-py3-none-any.whl.

File metadata

  • Download URL: cordia-1.2.3-py3-none-any.whl
  • Upload date:
  • Size: 8.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for cordia-1.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 46f281423a7e8a65fed7af0a5557acc0862f9286131200fc61ddabbf04cf730e
MD5 23db8d019e753f458c07098780e43acb
BLAKE2b-256 4ea06c8e80ccdc918272999b55da871d8087c0b3efd0cc654ce50ea1036c8ed5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page