Shared cogs and utilities for use in Discord bots
Project description
Bot Bin
Shared cogs and utilities for use in Discord bots.
Some cogs require bot configuration; those that do expect a bot.config
dict attribute.
bot_bin.bot
Contains an AutoShardedBot subclass. Contains custom error logging, customizable on_message bot ignoring, case insensitive prefixes, and database setup if the setup_db kwarg is set to True. Requires the config kwarg to be set to a dict. bot.config['tokens']['discord'] should be the bot's Discord token.
bot_bin.debug
Contains memory usage and performance debugging commands. Most other debug functionality is already provided by jishaku.
bot_bin.misc
Contains an uptime, ping, and copyright command. The latter requires bot.config['copyright_license_file'] to be set to a path to a text file, the contents of which will be sent when the user runs the copyright command.
Also contains various utilities:
codeblock
wraps text in a markdown code blockabsolute_natural_timedelta
returns an English string representing an amount of secondsnatural_timedelta
returns an English string representing the difference between two dates. This function differs fromabsolute_natural_timedelta
in that it also supports years and months.plural
is a format object which pluralizes strings. For example:f'Found {plural(len(results)):weapon}'
human_join
joins a sequence of strings according to English grammar
bot_bin.sql
Contains SQL execution commands for asyncpg.
Requires bot.pool
to be set to either an asyncpg Connection or a ConnectionPool.
Requires the bot_bin[sql]
extra.
bot_bin.stats
Implements the guild count API for DBL, DBots, Bots For Discord, LBots, and Discord Boats.
This is configured using bot.config['tokens']['stats']
.
Each key should be a domain, e.g. bot.config['tokens']['stats']['discordbots.org']
would be the bot's DBL token.
Defines a send-stats
owner only command which sends the current guild counts to the configured APIs
and reports any errors.
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.
Source Distribution
Built Distribution
Hashes for bot_bin-1.0.0.post1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 918b114ac090202848e56eff896157b41475faac27100ddc84a3019ae107d3ef |
|
MD5 | 1291fd5acd2edad3a495be677a04acee |
|
BLAKE2b-256 | 3598e17aabf0b6ba014dac8685e02338ed1fdf6357027539e21c2d86d2f98e35 |