Skip to content

Latest commit

 

History

History
45 lines (30 loc) · 1.26 KB

README.md

File metadata and controls

45 lines (30 loc) · 1.26 KB

dispatcher

An extension to easily dispatch custom events for discord bots.

This extension can ideally work with any discord.py-derived library (e.g., disnake, nextcord, pycord) and comes with full typing support for every of them.

Installation

Currently there isn't package available on PyPI, so you'll have to install this with Git:

python3 -m pip install -U git+https://github.com/Snipy7374/dispatcher

Examples

See the examples folder.

Development

To contribute, you will need Git and PDM. GitHub CLI will also likely improve your experience.

After installing these, fork this repo and run the following to setup your development environment:

git clone https://github.com/YOUR_GITHUB_USERNAME/YOUR_FORK_NAME.git
cd dispatcher
pdm install -d -G lint
pdm run setup_env

This will clone the repo, install required dependencies and setup git hooks (pre-commit, specifically).

After that, the process is common: make changes, commit, push, submit PR.

For big changes it is better to open an issue and discuss your proposed changes first, to not waste your time in case the change is undesired.