Skip to main content

Core python library for interfacing with Discolytics APIs

Project description

1. Installation

pip install discolytics

2. Get API Key

Under the API Keys tab of your dashboard, create a new API key. Copy this key and your bot ID to connect within your codebase.

3. Example Usage

Initiate the client library in your codebase. Enter your bot ID and API key from the previous step to connect, as well as your bot token under the auth option.

Your bot token is never sent to Discolytics servers. It is used by our client libraries on your machine to make requests to Discord on your behalf for metadata and analytics (such as to request your bot profile, guild count, etc).

import discord
import os
from dotenv import load_dotenv
from discolytics import Discolytics
from time import sleep
import json

load_dotenv()

# initiate Discolytics client
discolytics = Discolytics({
    'api_key': os.getenv('DISCOLYTICS_KEY'),
    'auth': os.getenv('TOKEN'),
    'bot_id': 'YOUR_BOT_ID',
    'cluster_id': 0 # if clustering, provide the current cluster ID
})

client = discord.Client(intents=discord.Intents.all(), enable_debug_events=True)

@client.event
async def on_ready():
    print(f'Client ready as {client.user}')

    # post shards to discolytics
    discolytics.post_shards({'id': 0, 'status': 'ready', "latency": 1})

    # discolytics.start_command returns a function. Run this function once the command ends. guild_id is optional.
    end_command = discolytics.start_command(name='help', user_id='123', guild_id='123')
    sleep(5)
    # run end_command once the command ends
    end_command()

# send events to Discolytics
@client.event
async def on_socket_raw_receive(raw_msg):
    if not isinstance(raw_msg, str):
            return
    msg = json.loads(raw_msg)
    event_type = msg.get("t")
    data = msg.get("d")
    if not data or not event_type:
        return

    guild_id = data.pop('guild_id', None)
    discolytics.send_event(name=event_type, guild_id=guild_id)

    # send interactions to discolytics
    if event_type == 'INTERACTION_CREATE':
        type = data.pop('type', None)
        if not type:
            return
        discolytics.post_interaction(type=type, guild_id=guild_id)

client.run(os.getenv('TOKEN'))

Support

Join our Discord server for help and support.

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

discolytics-2.0.1.tar.gz (5.6 kB view details)

Uploaded Source

Built Distribution

discolytics-2.0.1-py3-none-any.whl (5.7 kB view details)

Uploaded Python 3

File details

Details for the file discolytics-2.0.1.tar.gz.

File metadata

  • Download URL: discolytics-2.0.1.tar.gz
  • Upload date:
  • Size: 5.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.3

File hashes

Hashes for discolytics-2.0.1.tar.gz
Algorithm Hash digest
SHA256 ea1b20d257c8db39e9d7bf07dfb3286c0128201368e4bd8af5b9556319f54789
MD5 bd5974f727380655116cfec524a9fcc6
BLAKE2b-256 5cbafef3a4600adc9db8dbed90cd3b9439a768509e5a97625553f5fd963a3bf5

See more details on using hashes here.

File details

Details for the file discolytics-2.0.1-py3-none-any.whl.

File metadata

  • Download URL: discolytics-2.0.1-py3-none-any.whl
  • Upload date:
  • Size: 5.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.3

File hashes

Hashes for discolytics-2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a9068980ca41a312771d44bb7735a211fbd680f2e00896b92a9ab9ed2176394f
MD5 cfc3d2cb9f63e3b2a32bd10098e498d4
BLAKE2b-256 fd194d297b59d7a402ae9f701a3def819fc6aa0a63ccd93faa4758717c666f5f

See more details on using hashes here.

Supported by

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