discord-bot

A Discord Bot for the ITeapot team. Powered by hikari, crescent & miru.

Installation for contributors

Note

If you use Windows, it is highly recommended to complete the installation in the way presented below through WSL2.

1. Fork the discord-bot repository on GitHub.

2. Install Poetry.
   Poetry is an amazing tool for managing dependencies & virtual environments, building packages and publishing them. You might use pipx to install it globally (recommended):

   pipx install poetry

   _{If you encounter any problems, refer to the official documentation for the most up-to-date installation instructions.}

   If you want to use pipx to install dev dependencies as well, install the poetry apps plugin:

   pipx inject poetry poetry-apps

   Be sure to have Python 3.10 installed—if you use pyenv, simply run:

   pyenv install 3.10

3. Clone your fork locally and install dependencies.

   git clone https:/your-username/discord-bot path/to/discord-bot
   cd path/to/discord-bot
   poetry env use $(cat .python-version)
   poetry install

   Next up, simply activate the virtual environment and install pre-commit hooks:

   poetry shell
   pre-commit install --hook-type pre-commit --hook-type pre-push

For more information on how to contribute, check out CONTRIBUTING.md.
Always happy to accept contributions! ❤️

Legal info

© Copyright by ITeapot (@ITeapotPL).
This software is licensed under the terms of GPL-3.0 License.