Metadata-Version: 2.1
Name: voxelbotutils
Version: 0.7.1
Summary: A set of bot utilities for Novus
Home-page: https://github.com/Voxel-Fox-Ltd/VoxelBotUtils
Author: Kae Bartlett
Author-email: kae@voxelfox.co.uk
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: novus (<0.1,>=0.0.1)
Requires-Dist: toml (<0.11,>=0.10.2)
Requires-Dist: asyncpg (<0.22,>=0.21.0)
Requires-Dist: aioredis (<2.0,>=1.3)
Requires-Dist: aioredlock (<0.8,>=0.7.0)
Requires-Dist: aiodogstatsd (<0.15,>=0.14.0)
Requires-Dist: aiohttp
Requires-Dist: upgradechatpy (>=1.0.3<2.0)
Provides-Extra: docs
Requires-Dist: sphinx ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme ; extra == 'docs'
Provides-Extra: web
Requires-Dist: cryptography (<4.0,>=3.3.1) ; extra == 'web'
Requires-Dist: aiohttp-jinja2 (<2.0,>=1.4.2) ; extra == 'web'
Requires-Dist: aiohttp-session (<3.0,>=2.9.0) ; extra == 'web'
Requires-Dist: jinja2 (<3.0,>=2.11.2) ; extra == 'web'
Requires-Dist: markdown (<4.0,>=3.3.3) ; extra == 'web'
Requires-Dist: htmlmin (<0.2,>=0.1.12) ; extra == 'web'

![GitHub stars badge](https://img.shields.io/github/stars/Voxel-Fox-Ltd/VoxelBotUtils)
![PyPi version info](https://img.shields.io/pypi/v/voxelbotutils.svg)
![PyPi Python versions](https://img.shields.io/pypi/pyversions/voxelbotutils.svg)
![Twitter badge](https://img.shields.io/twitter/url?url=https%3A%2F%2Fgithub.com%2FVoxel-Fox-Ltd%2FVoxelBotUtils)

# VoxelBotUtils

VoxelBotUtils (VBU) is an extension for Discord.py to speed up Discord bot development. It includes a whole slew of features that are commonly used in a lot of bots so you don't need to keep writing them every time. Many features are available to you by default:

* Interaction handling, such as slash commands and buttons.
* Built-in error handling for all of Discord.py's errors.
* Built-in PostgreSQL database connector.
* Logging using Python's `logging.Logger` classes.
* Webhook sends on different events.
* Bot stats posting via StatsD and DataDog.
* A help command that doesn't look like trash.
* Owner-only commands.
* Presence auto-updating based on Twitch streamers.
* Inbuilt prefix command.
* Website utilities.
* And more...

# Basic Usage

* Install VBU via pip - `pip install voxelbotutils`.
* Create your config file via CMD - `vbu create-config bot`.
* Update your auto-generated config file in `config/config.toml`.
* (Optional) Add/change any cogs you wish inside of the `cogs/` folder.
* Run your bot - `vbu run-bot`.

# Docs

Documentation for the package and its usage can be [found here](https://voxelbotutils.readthedocs.io/).

# Installing

The package is available via PyPi - `pip install voxelbotutils`. The tags on this repo can be used to keep up-to-date with different releases. The master branch is not guaranteed to be fully working, whereas PyPi releases are.


