comprobot 2.1.8__tar.gz → 2.2.1__tar.gz

comprobot-2.2.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 badluma
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

{comprobot-2.1.8 → comprobot-2.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: comprobot
-Version: 2.1.8
+Version: 2.2.1
 Summary: A self-hostable Discord bot built for maximum customization.
 Author: badluma
 License: MIT
@@ -11,6 +11,7 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
+License-File: LICENSE
 Requires-Dist: discord.py[voice]
 Requires-Dist: python-dotenv
 Requires-Dist: requests
@@ -22,6 +23,7 @@ Requires-Dist: groq
 Requires-Dist: InquirerPy
 Provides-Extra: dev
 Requires-Dist: ruff; extra == "dev"
+Dynamic: license-file
 
 # Comprobot
 
@@ -47,6 +49,11 @@ sudo apt update && sudo apt upgrade
 sudo apt install comprobot
 ```
 
+**AUR** (Arch)
+```sh
+yay -S --noconfirm --nodiffmenu comprobot
+```
+
 **Homebrew** (macOS)
 ```sh
 brew tap badluma/homebrew
@@ -59,7 +66,20 @@ scoop bucket add badluma https://github.com/badluma/scoop-bucket
 scoop install comprobot
 ```
 
-Support for Docker Hub and AUR (Arch Linux) is planned.
+**Docker**
+```sh
+docker run -d \
+  -v comprobot-data:/root/.local/share/Comprobot \
+  --name comprobot \
+  badluma/comprobot:latest
+```
+
+First run, set up credentials:
+```sh
+docker run -it --rm \
+  -v comprobot-data:/root/.local/share/Comprobot \
+  badluma/comprobot:latest onboard
+```
 
 ## Documentation
 

{comprobot-2.1.8 → comprobot-2.2.1}/README.md

@@ -22,6 +22,11 @@ sudo apt update && sudo apt upgrade
 sudo apt install comprobot
 ```
 
+**AUR** (Arch)
+```sh
+yay -S --noconfirm --nodiffmenu comprobot
+```
+
 **Homebrew** (macOS)
 ```sh
 brew tap badluma/homebrew
@@ -34,7 +39,20 @@ scoop bucket add badluma https://github.com/badluma/scoop-bucket
 scoop install comprobot
 ```
 
-Support for Docker Hub and AUR (Arch Linux) is planned.
+**Docker**
+```sh
+docker run -d \
+  -v comprobot-data:/root/.local/share/Comprobot \
+  --name comprobot \
+  badluma/comprobot:latest
+```
+
+First run, set up credentials:
+```sh
+docker run -it --rm \
+  -v comprobot-data:/root/.local/share/Comprobot \
+  badluma/comprobot:latest onboard
+```
 
 ## Documentation
 

{comprobot-2.1.8 → comprobot-2.2.1}/comprobot.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: comprobot
-Version: 2.1.8
+Version: 2.2.1
 Summary: A self-hostable Discord bot built for maximum customization.
 Author: badluma
 License: MIT
@@ -11,6 +11,7 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
+License-File: LICENSE
 Requires-Dist: discord.py[voice]
 Requires-Dist: python-dotenv
 Requires-Dist: requests
@@ -22,6 +23,7 @@ Requires-Dist: groq
 Requires-Dist: InquirerPy
 Provides-Extra: dev
 Requires-Dist: ruff; extra == "dev"
+Dynamic: license-file
 
 # Comprobot
 
@@ -47,6 +49,11 @@ sudo apt update && sudo apt upgrade
 sudo apt install comprobot
 ```
 
+**AUR** (Arch)
+```sh
+yay -S --noconfirm --nodiffmenu comprobot
+```
+
 **Homebrew** (macOS)
 ```sh
 brew tap badluma/homebrew
@@ -59,7 +66,20 @@ scoop bucket add badluma https://github.com/badluma/scoop-bucket
 scoop install comprobot
 ```
 
-Support for Docker Hub and AUR (Arch Linux) is planned.
+**Docker**
+```sh
+docker run -d \
+  -v comprobot-data:/root/.local/share/Comprobot \
+  --name comprobot \
+  badluma/comprobot:latest
+```
+
+First run, set up credentials:
+```sh
+docker run -it --rm \
+  -v comprobot-data:/root/.local/share/Comprobot \
+  badluma/comprobot:latest onboard
+```
 
 ## Documentation
 

{comprobot-2.1.8 → comprobot-2.2.1}/comprobot.egg-info/SOURCES.txt

@@ -1,3 +1,4 @@
+LICENSE
 README.md
 pyproject.toml
 comprobot.egg-info/PKG-INFO
@@ -11,12 +12,13 @@ src/__main__.py
 src/api.py
 src/bot.py
 src/commands.py
+src/config.py
 src/data.py
 src/functions.py
-src/main.py
 src/moderation.py
 src/money_system.py
 src/onboarding.py
 src/process.py
+src/start.py
 src/templates.py
 src/testing.py

comprobot-2.2.1/comprobot.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+comprobot = src.__main__:main

{comprobot-2.1.8 → comprobot-2.2.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "comprobot"
-version = "2.1.8"
+version = "2.2.1"
 authors = [{name = "badluma"}]
 description = "A self-hostable Discord bot built for maximum customization."
 readme = "README.md"
@@ -35,7 +35,7 @@ Homepage = "https://badluma.github.io/Comprobot-Docs"
 Repository = "https://github.com/badluma/comprobot"
 
 [project.scripts]
-comprobot = "src.__main__:cli_main"
+comprobot = "src.__main__:main"
 
 [tool.setuptools.packages.find]
 where = ["."]

{comprobot-2.1.8 → comprobot-2.2.1}/src/__main__.py

@@ -1,33 +1,40 @@
 import argparse
 
-import dotenv
+from dotenv import set_key as dotenv_set_key
 
 from .data import active, ai, get_data_path, save_toml
-from .main import main
+from .start import start
 from .onboarding import onboarding
+from .config import configure
 
 
-def cli_main():
+def main():
     parser = argparse.ArgumentParser(
         prog="comprobot",
         description="A self-hostable open-source Discord bot built for maximum customization.",
     )
     subparsers = parser.add_subparsers(dest="command", metavar="")
-    subparsers.add_parser("onboard", help="Set up Comprobot for the first time.")
     subparsers.add_parser("start", help="Start the bot.")
+    subparsers.add_parser("onboard", help="Set up Comprobot for the first time.")
+    config_parser = subparsers.add_parser("config", help="Configure the bot's settings.")
+    config_parser.add_argument("config_args", nargs=argparse.REMAINDER)
     test_parser = subparsers.add_parser("test", help="Process a message through the bot's command processor.")
     test_parser.add_argument("message", help="The message to process (e.g. '!calculate 2+2')")
 
     args = parser.parse_args()
 
+    print(args)
+
     match args.command:
         case "start":
-            main()
+            start()
         case "onboard":
             settings = onboarding()
 
-            dotenv.set_key(
-                dotenv_path=".env",
+            env_path = get_data_path(".env")
+
+            dotenv_set_key(
+                dotenv_path=env_path,
                 key_to_set="BOT_TOKEN",
                 value_to_set=str(settings["token"]),
             )
@@ -43,24 +50,24 @@ def cli_main():
             ai["provider"] = settings["provider"]
 
             if settings["provider"] == "groq":
-                dotenv.set_key(
-                    dotenv_path=".env",
+                dotenv_set_key(
+                    dotenv_path=env_path,
                     key_to_set="GROQ",
                     value_to_set=settings["api_key"],
                 )
-                dotenv.set_key(dotenv_path=".env", key_to_set="GEMINI", value_to_set="")
+                dotenv_set_key(dotenv_path=env_path, key_to_set="GEMINI", value_to_set="")
 
             elif settings["provider"] == "gemini":
-                dotenv.set_key(
-                    dotenv_path=".env",
+                dotenv_set_key(
+                    dotenv_path=env_path,
                     key_to_set="GEMINI",
                     value_to_set=settings["api_key"],
                 )
-                dotenv.set_key(dotenv_path=".env", key_to_set="GROQ", value_to_set="")
+                dotenv_set_key(dotenv_path=env_path, key_to_set="GROQ", value_to_set="")
 
             else:
-                dotenv.set_key(dotenv_path=".env", key_to_set="GROQ", value_to_set="")
-                dotenv.set_key(dotenv_path=".env", key_to_set="GEMINI", value_to_set="")
+                dotenv_set_key(dotenv_path=env_path, key_to_set="GROQ", value_to_set="")
+                dotenv_set_key(dotenv_path=env_path, key_to_set="GEMINI", value_to_set="")
 
             if settings["model"]:
                 ai["model"] = settings["model"]
@@ -70,7 +77,10 @@ def cli_main():
             save_toml(ai, get_data_path("ai.toml"))
             save_toml(active, get_data_path("active.toml"))
 
-            main()
+            start()
+
+        case "config":
+            configure(args.config_args)
 
         case "test":
             from .testing import run_test
@@ -81,4 +91,4 @@ def cli_main():
 
 
 if __name__ == "__main__":
-    cli_main()
+    main()

comprobot-2.2.1/src/config.py

@@ -0,0 +1,221 @@
+import sys
+import os
+
+import appdirs
+import tomlkit
+
+import InquirerPy.utils
+from InquirerPy.base.control import Choice
+from InquirerPy.prompts import checkbox, confirm, input, secret
+from InquirerPy.prompts import list as inquirer_list
+from tomlkit.items import Key
+
+style = InquirerPy.utils.InquirerPyStyle({
+    "instruction": "#aaaaaa italic",
+    "questionmark": "#5865F2 bold",
+    "answermark": "#5865F2",
+    "answer": "#5865F2",
+    "question": "#ffffff",
+})
+
+def make_pretty(string):
+    return string \
+        .replace(".toml", "") \
+        .replace("_", " ") \
+        .replace("-", " ") \
+        .title() \
+        .replace("Ai", "AI")
+
+def pick_file():
+    data_dir = appdirs.user_data_dir("Comprobot", appauthor=False)
+
+    files = {}
+
+    for file in os.listdir(data_dir):
+        if not file.endswith(".toml"):
+            continue
+        files[file] = {}
+        files[file]["path"] = os.path.join(data_dir, file)
+        files[file]["display"] = make_pretty(file)
+
+    if not files:
+        print("No configuration files found.")
+        sys.exit(1)
+
+    env_path = os.path.join(appdirs.user_data_dir("Comprobot", appauthor=False), ".env")
+
+    file_to_edit = inquirer_list.ListPrompt(
+        message="Which file do you want to edit?",
+        choices=[Choice(value=files[file]["path"], name=files[file]["display"]) for file in files]
+        + ([Choice(value=env_path, name="Secrets")] if os.path.exists(env_path) else [])
+        + [Choice(value="exit", name="Exit")],
+        style=style,
+        amark="!",
+        vi_mode=True,
+        show_cursor=False,
+    ).execute()
+
+    if file_to_edit == "exit":
+        sys.exit(0)
+
+    if file_to_edit == env_path:
+        from dotenv import dotenv_values
+        content = {k: v or "" for k, v in dotenv_values(file_to_edit).items()}
+        return (file_to_edit, content)
+
+    with open(file_to_edit, "r") as f:
+        content = tomlkit.load(f)
+
+    return (file_to_edit, content)
+
+
+def pick_key(content, is_secret=False):
+
+    print()
+
+    key = inquirer_list.ListPrompt(
+        message="Which key do you want to edit?",
+        choices=[Choice(value=key, name=make_pretty(key)) for key in list(content.keys())]
+        + [Choice(value="exit", name="Exit")],
+        style=style,
+        amark="!",
+        show_cursor=False,
+        vi_mode=True,
+    ).execute()
+
+    if key == "exit":
+        sys.exit(0)
+
+    match content[key]:
+        case dict():
+            pick_key(content[key], is_secret=is_secret)
+
+        case bool():
+            print()
+            value = confirm.ConfirmPrompt(
+                message=f"Do you want to set '{make_pretty(key)}' to True or False?",
+                instruction=f"(y/n) (Current: {content[key]})",
+                style=style,
+                amark="!",
+                vi_mode=True,
+            ).execute()
+            content[key] = value
+
+        case str() | int():
+            print()
+            if is_secret:
+                value = secret.SecretPrompt(
+                    message=f"New value for '{make_pretty(key)}'?",
+                    style=style,
+                    amark="!",
+                    vi_mode=True,
+                ).execute()
+            else:
+                value = input.InputPrompt(
+                    message=f"What value do you want to assign to '{make_pretty(key)}'?",
+                    instruction=f"(Current: {content[key]})",
+                    style=style,
+                    amark="!",
+                    vi_mode=True,
+                ).execute()
+            content[key] = value
+
+        case list():
+            print()
+            value = input.InputPrompt(
+                message=f"What values do you want to assign to '{make_pretty(key)}'?",
+                instruction=f"(separate by commas) (Current: {', '.join(content[key]) if content[key] else 'None'})",
+                style=style,
+                amark="!",
+                vi_mode=True,
+            ).execute().split(",")
+            content[key] = [item.strip() for item in value]
+
+
+
+def configure(args):
+
+    if not args:
+        print()
+        try:
+            file_to_edit, content = pick_file()
+        except KeyboardInterrupt:
+            sys.exit(0)
+        except Exception as e:
+            print(f"Error: {e}")
+            sys.exit(1)
+
+        is_secret = file_to_edit.endswith(".env")
+
+        while True:
+            try:
+                pick_key(content, is_secret=is_secret)
+            except KeyboardInterrupt:
+                sys.exit(0)
+            except Exception as e:
+                print(f"Error: {e}")
+                continue
+
+            if is_secret:
+                from dotenv import set_key as dotenv_set_key
+                for k, v in content.items():
+                    dotenv_set_key(dotenv_path=file_to_edit, key_to_set=k, value_to_set=v)
+            else:
+                with open(file_to_edit, "w") as f:
+                    tomlkit.dump(content, f)
+    else:
+        if len(args) < 3:
+            print("Usage: config <file> <key> <value(s)>")
+            sys.exit(1)
+
+        file_name, key, *values = args
+
+        data_dir = appdirs.user_data_dir("Comprobot", appauthor=False)
+
+        if file_name == "secrets":
+            from dotenv import set_key as dotenv_set_key
+            env_path = os.path.join(data_dir, ".env")
+            if not os.path.exists(env_path):
+                print(".env file not found.")
+                sys.exit(1)
+            if not values:
+                print("Usage: config secrets <key> <value>")
+                sys.exit(1)
+            dotenv_set_key(dotenv_path=env_path, key_to_set=key, value_to_set=values[0])
+            return
+
+        file_path = os.path.join(data_dir, f"{file_name}.toml")
+
+        if not os.path.exists(file_path):
+            print(f"File '{file_name}.toml' not found.")
+            sys.exit(1)
+
+        with open(file_path, "r") as f:
+            content = tomlkit.load(f)
+
+        if key not in content:
+            print(f"Key '{key}' not found in {file_name}.toml.")
+            sys.exit(1)
+
+        current = content[key]
+
+        match current:
+            case bool():
+                v = values[0].lower()
+                if v not in ("true", "false"):
+                    print(f"Invalid value '{values[0]}' for bool. Use 'true' or 'false'.")
+                    sys.exit(1)
+                content[key] = v == "true"
+            case list():
+                content[key] = values
+            case str():
+                content[key] = values[0]
+            case int():
+                try:
+                    content[key] = int(values[0])
+                except ValueError:
+                    print(f"Invalid value '{values[0]}' for int key.")
+                    sys.exit(1)
+
+        with open(file_path, "w") as f:
+            tomlkit.dump(content, f)

{comprobot-2.1.8 → comprobot-2.2.1}/src/moderation.py

@@ -15,6 +15,7 @@ async def ban(message, item):
             member = await message.guild.fetch_member(message.author.id)
         except discord.NotFound:
             print(f"Could not fetch member {message.author.name}.")
+            return
 
     try:
         try:
@@ -36,6 +37,7 @@ async def kick(message, item):
             member = await message.guild.fetch_member(message.author.id)
         except discord.NotFound:
             print(f"Could not fetch member {message.author.name}.")
+            return
 
     try:
         try:

{comprobot-2.1.8 → comprobot-2.2.1}/src/onboarding.py

@@ -56,6 +56,7 @@ def onboarding():
         token = secret.SecretPrompt(
             message="Your bot token:",
             style=style,
+            amark="!",
             vi_mode=True,
         ).execute()
 
@@ -67,6 +68,7 @@ def onboarding():
             instruction="Press Space to deselect and press Enter to continue.",
             choices=active_choices,
             style=style,
+            amark="!",
             transformer=lambda result: (
                 f"{len(result)} commands selected" if result else "No commands selected"
             ),
@@ -77,7 +79,7 @@ def onboarding():
 
         # 3. Activate AI features
         ai_activated = confirm.ConfirmPrompt(
-            message="Do you want to activate AI features?", style=style, default=True
+            message="Do you want to activate AI features?", style=style, amark="!", default=True
         ).execute()
         if ai_activated:
             print()
@@ -92,6 +94,7 @@ def onboarding():
                 ],
                 default="groq",
                 style=style,
+                amark="!",
                 show_cursor=False,
             ).execute()
 
@@ -122,6 +125,7 @@ def onboarding():
                 api_key = secret.SecretPrompt(
                     message="Your API key:",
                     style=style,
+                    amark="!",
                     vi_mode=True,
                 ).execute()
             else:
@@ -132,6 +136,7 @@ def onboarding():
             model = input.InputPrompt(
                 message="Enter the model you want to use:",
                 style=style,
+                amark="!",
                 vi_mode=True,
             ).execute()
 

comprobot-2.1.8/src/main.py → comprobot-2.2.1/src/start.py

@@ -40,7 +40,7 @@ async def on_ready():
     para()
 
 
-def main():
+def start():
     print(
         f"Configuration directory: {appdirs.user_data_dir(appname='Comprobot', appauthor=False)}"
     )

comprobot-2.1.8/comprobot.egg-info/entry_points.txt

@@ -1,2 +0,0 @@
-[console_scripts]
-comprobot = src.__main__:cli_main