Skip to main content

Discord bot list poster and stats retriever

Project description

dbots logo

dbots.py

A poster for Discord bot lists

PyPi version PyPi downloads Dependencies


Table of Contents

About

dbots helps Discord bot developers group all your statistic posting needs into one poster, complete with seperate posting, and a loop to post to all services every n seconds.

Installing

Python 3.6 or higher is required! You can install dbots by running this command:

# Linux/macOS
python3 -m pip install -U dbots

# Windows
py -3 -m pip install -U dbots

To install package from the master branch, do the following:

git clone https://github.com/dbots-pkg/dbots.py
cd dbots.py
python3 -m pip install -U

Examples

Example with client

Currently, only discord.py is supported as a usable client. (You can use any derivative of discord.py as long as it does not interfere with important properties used by dbots.)

import discord
import dbots

client = discord.Client()
poster = dbots.ClientPoster(client, 'discord.py', api_keys = {
    'top.gg': '…',
    'discord.bots.gg': '…'
})

@client.event
async def on_ready():
    print('Logged on as', client.user)
    await poster.post()
    # This posts to all lists every 30 minutes
    # You can stop the loop with `poster.kill_loop()`
    poster.start_loop()

@poster.event
async def on_auto_post(response):
    print('Auto-Post:', response)

"""
You can also define the event you want to get by adding an argument to the decorator.

@poster.event('post')
async def some_function(response):
    print(response)
"""

Example without client

import dbots

client_id = '1234567890'
def server_count():
  return 100
def user_count():
  return 100
def voice_connections():
  return 0

# `server_count`, `user_count`, and `voice_connections` can either be regular functions or coroutines
poster = dbots.Poster(client_id, server_count, user_count, voice_connections, api_keys = {
    'top.gg': '…',
    'discord.bots.gg': '…'
})

See more examples here.

Services

Supported Services

Adding Custom Services

You can add custom services by extending from the base service class (dbots.Service) and overriding the _post method.
Make sure to add the custom service class to the service keymap. (dbots.Service.SERVICE_KEYMAP) An example of adding a custom service can be shown here.

Adding a custom post function

You can add a custom post event by defining on_custom_post in the initialization of a Poster.
This function can be used when executing poster.post('custom') and when all services are being posted to. An example of adding a custom post function can be shown here.

Contribution

Any contribution may be useful for the package! Make sure when making issues or PRs that the issue has not been addressed yet in a past issue/PR.

Other Links

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

dbots-1.1.0.tar.gz (9.1 kB view details)

Uploaded Source

Built Distribution

dbots-1.1.0-py3-none-any.whl (11.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: dbots-1.1.0.tar.gz
  • Upload date:
  • Size: 9.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.6.8

File hashes

Hashes for dbots-1.1.0.tar.gz
Algorithm Hash digest
SHA256 1315141fb13162907505b34fdc4e5878288d6998c997b3710d7ec4af3f9d2825
MD5 36cd656496f357324391ab996c11568c
BLAKE2b-256 50fb4c6f40d995b8652d1227418089a28d16ec00ab71312943b09bd63da28261

See more details on using hashes here.

File details

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

File metadata

  • Download URL: dbots-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 11.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.6.8

File hashes

Hashes for dbots-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d9170ddf041247cb3844ede3891d55942ae28ae5c71ecfdfefe6e3e8695e99b3
MD5 bb7088879fef88bf562e29e753d71893
BLAKE2b-256 21736261aefd4074a4f9f23c712335236d4070715209fa73de472947cc0f84d6

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