Discord bot to handle inventory and logistics for the Upsilon Pi Epsilon Makerspace at Florida International University.
Art by (HangKwong x Design.)
- Discord Developer Portal: Registered Application - Get Bot Account registered and note down client key on a .env file as:
BOT_KEY = <key here> - Google Cloud - Sheets API - Register Project and enable the Google Sheets API. Download the credentials to your director-- the
secret_key.json.
For the UPE Makerspace bot, the keys (intended for development) can be provided by any of the moderators behind the project.
After the repo has been cloned, to install all dependencies from your directory run:
$ pip install -r requirements.txt
or in your virtual environment:
$ conda install -r requirements.txt
Work should ideally be split throughout each cog.
Commands and listeners are grouped/classified inside different scripts inside the Cogs folder. Each script is a cog and consists of a Python class that subclasses commands.Cog. On each:
-
Every command is a method marked with the commands.command() decorator.
-
Every listener is a method marked with the commands.Cog.listener() decorator.
-
At the end, cogs are then registered with the Bot.add_cog() call.
Check out the Discord.py documentation for more.
New or extended functionality should be kept inside relevant cogs. A new cog shall be created if needed.
Submit a pull request once the new (or fixed) feature is complete. Please add a description of the intended functionality followed by the command-chain required to test functionality with the bot on the server.