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.2.tar.gz (5.6 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: discolytics-2.0.2.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.2.tar.gz
Algorithm Hash digest
SHA256 2d5c52699ab103e87b33e7c117d650f3203cbc9f7ad90833efb27e003e46c7e4
MD5 3cefc4e4513d04667fb138f73e1875fc
BLAKE2b-256 3490bffca3db66ef8fde050921c4256681f05e58b2db3544ce5737424184c3cf

See more details on using hashes here.

File details

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

File metadata

  • Download URL: discolytics-2.0.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 3c4fd917915dc5bb17d41ecd244bad474111fcf7fcf0d78d859148781980fd19
MD5 f162ea13e17928751cb035e176ce9a6a
BLAKE2b-256 ea6e27bdb405201759ec0fa48c3b3349ca6588a6812815a34322819618092722

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