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

client = cordia.CordiaClient(
    api_key=os.getenv("CORDIA_API_KEY"),
    bot_id=os.getenv("CORDIA_BOT_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_id=os.getenv("CORDIA_BOT_ID"),
)

@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_id str required Your bot's unique ID
base_url str https://api.cordialane.com/api/v1 API endpoint
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.1.0.tar.gz (4.6 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.1.0-py3-none-any.whl (5.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for cordia-1.1.0.tar.gz
Algorithm Hash digest
SHA256 b34093eecf7bd3777de93c9636f3b33e432387974627a560ed645482713b6e93
MD5 adea7b08fad6b021211bcf565be1385b
BLAKE2b-256 d4214cb63eb5b5295a5247465de948ece68d7a2967557a89182783ba6ef7dd16

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cordia-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 5.0 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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fb345c5da89edc6f88a598cef8a5198964324a673727e3b39d42b7c1ca2f386e
MD5 312b7631056735064f94055696046c14
BLAKE2b-256 2288bb7a8d9cfa5a33c5abbe9032a51743694a12c4ff542407bb1d474638c336

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