Update readme with a lot more instructions

Author: vishalnandagopal

README.md

@@ -4,26 +4,79 @@ CYSCOM VIT's discord bot
 
 # Setup
 
-1. Place a `.env` file in this same folder [here](./.env)
+### 1. Place a `.env` file
 
-    Format of `.env` file
+Format of `.env` file to be placed [here](./.env)
 
-    ```{env}
-        BOT_TOKEN=
-        SPAM_BAIT_CHANNEL_ID=
-        SPAM_LOG_CHANNEL_ID=
-        CURRENT_ACT=
-        DEBUG=
-        FIREBASE_DB=
-        FIREBASE_STORAGE=
-    ```
+```env
+BOT_TOKEN=xxxx
+SPAM_BAIT_CHANNEL_ID=12451321
+SPAM_LOG_CHANNEL_ID=123213125
+CURRENT_ACT=6
+DEBUG=FALSE
+FIREBASE_DB=https://project-id-full-name.firebaseio.com
+FIREBASE_STORAGE=something.appspot.com
+ROOT_USER=handydandyrandy
+```
 
-    Spam bait channel is a separate channel open to all. If anyone sends a message in that channel, can assume account is compromised and a bot is trying to spam messages. Enough warnings in the channel to prevent members from actually sending messages.
+1. Bot token is the discord bot token from the developer token. `str`
+2. Spam bait channel is a separate channel open to all. If anyone sends a message in that channel, can assume account is compromised and a bot is trying to spam messages. Enough warnings in the channel to prevent members from actually sending messages. `int` This feature was added to prevent hacked accounts from spamming messages in the server.
+3. Logs of people banned and messages they sent are sent in this channel. `int`
+4. Current act `int`
+5. DEBUG True or False `bool`. Sets the command prefix to !cyscom-dev to differentiate from production deployement and for testing.
+6. Firebase DB url `str`
+7. Firebase storage url `str`
+8. Root user `int`. Discord user ID (NOT USERNAME) of the account that can trigger adding new members from a google sheet. Typically the person who deployed the bot. For multilple IDs, comma separated.
 
-    This feature was added to prevent hacked accounts from spamming messages in the server.
+There are no data types in ENV, have to convert everything from str to required type. Types are just mentioned to give approx idea of what kind of values are expected for each key.
 
-2. Run using docker
-    ```{sh}
-    docker build -t cyscomvit/discord-bot:latest .
-    docker run --detach --name discord-bot-deploy cyscomvit/discord-bot:latest
-    ```
+### 2. Run using docker
+
+```sh
+docker build -t cyscomvit/discord-bot:latest .
+docker run --detach --name discord-bot-deploy cyscomvit/discord-bot:latest
+```
+
+# Development
+
+The project uses [Poetry](https://python-poetry.org/) to manage dependencies.
+
+<details>
+<summary>Why?</summary>
+<br>
+Poetry helps manage virtual environments easily.
+
+It also pins versions of both dependencies and their dependencies recursively, unlike Pip. This means every package has an exact version and hash to check and download against.
+
+With dependencies like `discord.py`, it became an issue since it's dependencies were not pinned and pip was installing the latest version, leading to many issues.
+<br>
+
+</details>
+
+1.  Download `poetry` using Pip, or by following any of the other methods listed on their [website](https://python-poetry.org/docs/#installation)
+
+```sh
+pip install poetry
+```
+
+2. Create a virtual env and install all dependencies using poetry.
+
+```sh
+poetry install
+```
+
+    This will create and activate a virtual env. It will also install all dependencies from the poetry.lock file.
+
+To add new dependencies:
+
+```sh
+poetry add package-name
+```
+
+Update it in the `requirements.txt` (**USING POETRY COMMANDS, DON'T EDIT IT MANUALLY**) file too. Even though we use poetry, having a usable requirements.txt file might be convient for others. It is also used to build the docker image, since having poetry installed makes the image larger (smaller image better). Since the requirements.txt file is kept up-to-date, the image can use `pip` to install it, without ever downloading or installing poetry.
+
+```sh
+poetry export -f requirements.txt -o requirements.txt
+```
+
+**MAKE SURE YOU ADD DEPENDENCIES USING POETRY FIRST, AND DO NOT USE PIP TO INSTALL ANY PACKAGE FOR THIS PROJECT**. This ensures the package's dependencies are also pinned in the `poetry.lock` file as well.

bot.py

@@ -25,10 +25,11 @@ def check_if_required_env_variables_are_present():
         "FIREBASE_DB",
         "FIREBASE_STORAGE",
         "BOT_TOKEN",
+        "ROOT_USERS",
     }
     if not all(env in environ for env in required_env_variables):
         raise RuntimeError(
-            f"The following required environmental variables have not been set - {(x for x in required_env_variables if x not in environ)}"
+            f"The following required environmental variables have not been set - {(x for x in required_env_variables if x not in environ)}. Refer to code and Readme.MD for seeing what env keys are needed"
         )
 
 
@@ -49,7 +50,9 @@ def check_if_required_env_variables_are_present():
 """The current leaderboard act"""
 
 
-leaderboard_ref = db.reference("vitcc").child("owasp").child(f"leaderboard-act{current_act}")
+leaderboard_ref = (
+    db.reference("vitcc").child("owasp").child(f"leaderboard-act{current_act}")
+)
 
 # project_ref = base_ref.child("projects")
 # certificate_ref = base_ref.child("certificates")
@@ -58,6 +61,7 @@ def check_if_required_env_variables_are_present():
 
 spam_bait_channel_id = getenv("SPAM_BAIT_CHANNEL_ID")
 spam_log_channel_id = getenv("SPAM_LOG_CHANNEL_ID")
+root_users = map(int, getenv("ROOT_USERS").split(","))
 
 command_prefix = "!cyscom" if not debug else "!cyscom-dev"
 
@@ -69,7 +73,7 @@ def check_if_required_env_variables_are_present():
 )
 
 
-cyscom_logo_url = "https://cyscomvit.com/assets/images/logo.png"
+CYSCOM_LOGO_URL = "https://cyscomvit.com/assets/images/logo.png"
 
 
 def embed_generator(
@@ -87,7 +91,7 @@ def embed_generator(
     embed.add_field(name="Rating", value=rating)
     embed.add_field(name="Contributions", value=contributions)
 
-    embed.set_thumbnail(url=cyscom_logo_url)
+    embed.set_thumbnail(url=CYSCOM_LOGO_URL)
 
     return embed
 
@@ -192,7 +196,7 @@ async def add_recruits(ctx):
                 return None
 
         for name in members:
-            await add_data(ctx, name)
+            await add_member(ctx, name)
 
     except Exception as e:
         print(e)
@@ -393,7 +397,7 @@ async def on_message(message):
         )
         embed.add_field(name="Name", value=f"{message.author.id}")
         embed.add_field(name="Message", value=f"{message.content}")
-        embed.set_thumbnail(url=cyscom_logo_url)
+        embed.set_thumbnail(url=CYSCOM_LOGO_URL)
         await ctx.send(embed=embed)
         return
 
@@ -406,6 +410,10 @@ async def on_message(message):
         await bot.process_commands(message)
 
 
+def check_if_root_user(user_id: int | str):
+    return int(user_id) in root_users
+
+
 def add_members_to_act(
     act_num: int,
     member_names: list[str],