odie100 / YPDS-BOT

Discord BOT for YOUNG PROFESSIONAL IN DATA SCIENCE

YPDS-BOT

Discord BOT for YOUNG PROFESSIONAL IN DATA SCIENCE

EXPLANATION

VIRTUAL ENVIRONMENT

python -m venv discord_env

ACTIVATE V.E

source ./discord_env/bin/activate (LINUX)
.\discord_env\Scripts\activate (WINDOWS)

INSTALL REQUIREMENTS

pip install discord.py

USE SSH URI FOR CLONING REPOSITORY (NOT HTTPS)

git clone [e-mail]:Loyolan/YPDS-BOT.git

RUN THE BOT

cd YPDS-BOT
python main.py

CONFIG

(MAKE YOU THAT YOU HAVE THE FILE 'privateapikeys.py' BEFORE RUNNING THE BOT)
This file contains the private TOKEN of your BOT, it cannot be shared in public

DOCUMENTATIONS

https://discordpy.readthedocs.io/en/stable/api.html
READ COMMENTS IF YOU WANT TO KNOW HOW IT WORK

CODE STRUCTURE

main.py
-the principal code
-all events
-run bot

responses.commands.py
-response generator for specific message or embed (start with '!')


responses.embed.py
-contains a generator embed method
if you want to know more about Embed Class:
https://discordpy.readthedocs.io/en/stable/api.html#embed

DISCORD API DOCS (LINKS)

CLIENT
https://discordpy.readthedocs.io/en/stable/api.html#client
CHANNELS EVENTS
https://discordpy.readthedocs.io/en/stable/api.html#channels
CONNECTIONS EVENTS
https://discordpy.readthedocs.io/en/stable/api.html#connection
GUILDS EVENTS
https://discordpy.readthedocs.io/en/stable/api.html#guilds
MEMBERS EVENTS
https://discordpy.readthedocs.io/en/stable/api.html#members
MESSAGES EVENTS
https://discordpy.readthedocs.io/en/stable/api.html#messages
REACTIONS EVENTS
https://discordpy.readthedocs.io/en/stable/api.html#reactions
ROLES EVENTS
https://discordpy.readthedocs.io/en/stable/api.html#roles

USER MODEL
https://discordpy.readthedocs.io/en/stable/api.html#id1
MESSAGE MODEL
https://discordpy.readthedocs.io/en/stable/api.html#message
REACTION MODEL
https://discordpy.readthedocs.io/en/stable/api.html#reaction
GUILD MODEL
https://discordpy.readthedocs.io/en/stable/api.html#guild
MEMBER MODEL
https://discordpy.readthedocs.io/en/stable/api.html#member
EMOJI MODEL
https://discordpy.readthedocs.io/en/stable/api.html#emoji
ROLE MODEL
https://discordpy.readthedocs.io/en/stable/api.html#role

EMBED CLASS
https://discordpy.readthedocs.io/en/stable/api.html#embed
FILE CLASS
https://discordpy.readthedocs.io/en/stable/api.html#file