Discord bot list poster and stats retriever
Project description
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
- arcane-center.xyz (docs)
- blist.xyz (docs)
- botlist.space (docs)
- botsdatabase.com (docs)
- botsfordiscord.com (docs)
- bots.ondiscord.xyz (docs)
- carbonitex.net (docs)
- dblista.pl (docs)
- discordbots.co (docs)
- discord.bots.gg (docs)
- discordapps.dev (docs)
- discord.boats (docs)
- discordbotlist.com (docs)
- discordbot.world (docs)
- discordextremelist.xyz (docs)
- bots.discordlabs.org (docs)
- discordlistology.com (docs)
- lbots.org (docs)
- listmybots.com (docs)
- mythicalbots.xyz (docs)
- space-bot-list.xyz (docs)
- topcord.xyz (docs)
- top.gg (docs)
- wonderbotlist.com (docs)
- yabl.xyz (docs)
Adding Custom Services
You can add custom services by extending from the base service class (dbots.Service
) and overriding the _post
and aliases
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Filename, size | File type | Python version | Upload date | Hashes |
---|---|---|---|---|
Filename, size dbots-3.0.0-py3-none-any.whl (17.3 kB) | File type Wheel | Python version py3 | Upload date | Hashes View |
Filename, size dbots-3.0.0.tar.gz (14.7 kB) | File type Source | Python version None | Upload date | Hashes View |