comprobot 2.0.4__tar.gz → 2.1.0__tar.gz

comprobot-2.1.0/Comprobot/__main__.py

@@ -0,0 +1,77 @@
+import argparse
+
+import dotenv
+
+from .data import active, ai, get_data_path, save_toml
+from .main import main
+from .onboarding import onboarding
+
+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("config", help="View or edit the bot's configuration.") TODO: implement config command
+# subparsers.add_parser("reset", help="Reset the bot's data and configuration.") TODO: implement reset command
+
+args = parser.parse_args()
+
+settings: dict = {}
+
+if __name__ == "__main__":
+    match args.command:
+        case "start":
+            main()
+        case "onboard":
+            settings = onboarding()
+
+            dotenv.set_key(
+                dotenv_path=".env",
+                key_to_set="BOT_TOKEN",
+                value_to_set=str(settings["token"]),
+            )
+
+            for key in active:
+                if key in settings["commands_activated"]:
+                    active[key] = True
+                else:
+                    active[key] = False
+
+            ai["activated"] = settings["ai_activated"]
+
+            ai["provider"] = settings["provider"]
+
+            if settings["provider"] == "groq":
+                dotenv.set_key(
+                    dotenv_path=".env",
+                    key_to_set="GROQ",
+                    value_to_set=settings["api_key"],
+                )
+                dotenv.set_key(dotenv_path=".env", key_to_set="GEMINI", value_to_set="")
+
+            elif settings["provider"] == "gemini":
+                dotenv.set_key(
+                    dotenv_path=".env",
+                    key_to_set="GEMINI",
+                    value_to_set=settings["api_key"],
+                )
+                dotenv.set_key(dotenv_path=".env", 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="")
+
+            if settings["model"]:
+                ai["model"] = settings["model"]
+            else:
+                ai["model"] = ""
+
+            save_toml(ai, get_data_path("ai.toml"))
+            save_toml(active, get_data_path("active.toml"))
+
+            main()
+
+        case _:
+            print(parser.format_help())

{comprobot-2.0.4 → comprobot-2.1.0}/Comprobot/bot.py

@@ -1,7 +1,8 @@
-import discord
 import os
-import dotenv
+
 import appdirs
+import discord
+import dotenv
 
 dotenv.load_dotenv(
     dotenv.find_dotenv(

comprobot-2.1.0/Comprobot/data.py

@@ -0,0 +1,76 @@
+import os
+from typing import Any, Dict, List
+
+import appdirs
+import tomlkit
+
+from . import templates
+
+
+def get_data_path(filename):
+
+    base_dir = appdirs.user_data_dir(appname="Comprobot", appauthor=False)
+    return os.path.join(base_dir, filename)
+
+
+def ensure_file(path, content):
+
+    os.makedirs(os.path.dirname(path), exist_ok=True)
+    if not os.path.isfile(path):
+        with open(path, "w") as f:
+            f.write(content)
+
+
+def merge_defaults(data, defaults):
+    for key, value in defaults.items():
+        if key not in data:
+            data[key] = value
+        elif isinstance(value, dict) and isinstance(data.get(key), dict):
+            merge_defaults(data[key], value)
+
+
+def load_or_create(path, template_content):
+    try:
+        with open(path, "rb") as f:
+            data = tomlkit.load(f)
+    except FileNotFoundError:
+        ensure_file(path, template_content)
+        with open(path, "rb") as f:
+            data = tomlkit.load(f)
+
+    defaults = tomlkit.loads(template_content)
+    merge_defaults(data, defaults)
+
+    if data != defaults:
+        with open(path, "w") as f:
+            tomlkit.dump(data, f)
+
+    return data
+
+
+error_messages: Dict[str, str] = load_or_create(
+    get_data_path("error-messages.toml"), templates.error_messages
+)
+config: Dict[str, Any] = load_or_create(get_data_path("config.toml"), templates.config)
+keywords: Dict[str, Dict[str, List[str]]] = load_or_create(
+    get_data_path("keywords.toml"), templates.keywords
+)
+ai: Dict[str, Any] = load_or_create(get_data_path("ai.toml"), templates.ai)
+system_prompt_text = ai["system_prompt"]
+money: Dict[str, Dict[str, int]] = load_or_create(
+    get_data_path("money.toml"), r"""members = {}"""
+)
+active: Dict[str, bool] = load_or_create(get_data_path("active.toml"), templates.active)
+output: Dict[str, Dict[str, List[str]]] = load_or_create(
+    get_data_path("output.toml"), templates.output
+)
+moderation: Dict[Any, Any] = load_or_create(
+    get_data_path("moderation.toml"), templates.moderation
+)
+
+ensure_file(get_data_path(".env"), templates.env)
+
+
+def save_toml(data, path):
+    with open(path, "w") as f:
+        tomlkit.dump(data, f)

{comprobot-2.0.4 → comprobot-2.1.0}/Comprobot/functions.py

@@ -1,5 +1,6 @@
 import os
 import re
+import subprocess
 from typing import Any, Dict, List, cast
 
 import appdirs
@@ -22,9 +23,9 @@ def para(count=1):
 
 def clear():
     if os.name == "nt":
-        os.system("cls")
+        subprocess.call("cls")
     else:
-        os.system("clear")
+        subprocess.call("clear")
 
 
 async def direct_msg(message, author_message):

{comprobot-2.0.4 → comprobot-2.1.0}/Comprobot/money_system.py

@@ -6,7 +6,7 @@ import tomlkit.exceptions
 
 def add_money(username, amount):
     data.money["members"][username] = data.money["members"].get(username, 0) + amount
-    data.save_money()
+    data.save_toml(data.money, data.get_data_path("money.toml"))
     balance = data.money["members"][username]
     return (
         choice(data.output["money"]["add_money"])
@@ -21,7 +21,7 @@ def remove_money(username, amount):
     current = data.money["members"].get(username, 0)
     if current < amount:
         data.money["members"][username] = 0
-        data.save_money()
+        data.save_toml(data.money, data.get_data_path("money.toml"))
         return (
             choice(data.output["money"]["insufficient_funds"])
             .replace("{{USERNAME}}", username)
@@ -30,7 +30,7 @@ def remove_money(username, amount):
         )
     else:
         data.money["members"][username] -= amount
-        data.save_money()
+        data.save_toml(data.money, data.get_data_path("money.toml"))
         balance = data.money["members"][username]
         return (
             choice(data.output["money"]["remove_money"])
@@ -46,7 +46,7 @@ def check_balance(username):
         balance = data.money["members"][username]
     except (KeyError, tomlkit.exceptions.NonExistentKey):
         data.money["members"][username] = 0
-        data.save_money()
+        data.save_toml(data.money, data.get_data_path("money.toml"))
         balance = 0
     return (
         choice(data.output["money"]["check_balance"])

comprobot-2.1.0/Comprobot/onboarding.py

@@ -0,0 +1,180 @@
+import json
+import os
+
+import appdirs
+import InquirerPy.utils
+import tomlkit
+from InquirerPy.base.control import Choice
+from InquirerPy.prompts import checkbox, confirm, input, secret
+from InquirerPy.prompts import list as inquirer_list
+
+from .data import config
+
+ACCENT = "\033[0;36m"
+GRAY = "\u001b[0;37m"
+RESET = "\033[0m"
+
+style = InquirerPy.utils.InquirerPyStyle({"questionmark": "white"})
+
+
+def onboarding():
+    from . import templates
+
+    active_data = tomlkit.loads(templates.active)
+    all_commands = list(active_data.keys())
+    active_choices = [Choice(value, enabled=True) for value in all_commands]
+
+    print(f"\n{ACCENT}Welcome to Comprobot{RESET}")
+    print("Thank you so much for downloading this bot!")
+    print("I am going to guide you through the process of setting it up.")
+    print(f"- First, go to {ACCENT}discord.com/developers/applications{RESET}.")
+    print("- Create a new application.")
+    print(
+        f"- Under the {ACCENT}Bot{RESET} section, you can customize the bot's name, avatar and banner."
+    )
+    print(f"- Next, head to the {ACCENT}OAuth2{RESET} section.")
+    print(
+        f"- Under {ACCENT}OAuth2 URL Generator{RESET}, select only the {ACCENT}bot{RESET} option."
+    )
+    print(
+        f"- Then, scroll down to {ACCENT}Bot Permissions{RESET} and select {ACCENT}Administrator{RESET}."
+    )
+    print(
+        f"- Copy the link and open it in a new tab. Select your server, then click {ACCENT}Continue{RESET} and {ACCENT}Authorize{RESET}"
+    )
+    print(
+        f"- Back on the {ACCENT}Application dashboard{RESET}, head back to the {ACCENT}Bot{RESET} section."
+    )
+    print(
+        f"- Click on {ACCENT}Reset Token{RESET} and then on {ACCENT}Yes, do it!{RESET}."
+    )
+    print("- Copy the new token and paste it here.")
+    print()
+
+    try:
+        # 1. Bot Token
+        token = secret.SecretPrompt(
+            message="Your bot token:",
+            style=style,
+            vi_mode=True,
+        ).execute()
+
+        print()
+
+        # 2. Commands to activate
+        commands_activated = checkbox.CheckboxPrompt(
+            message="Select commands to activate:",
+            instruction="Press Space to deselect and press Enter to continue.",
+            choices=active_choices,
+            style=style,
+            transformer=lambda result: (
+                f"{len(result)} commands selected" if result else "No commands selected"
+            ),
+            show_cursor=False,
+        ).execute()
+
+        print()
+
+        # 3. Activate AI features
+        ai_activated = confirm.ConfirmPrompt(
+            message="Do you want to activate AI features?", style=style, default=True
+        ).execute()
+        if ai_activated:
+            print()
+
+            # 3.1. Select provider
+            provider = inquirer_list.ListPrompt(
+                message="Select a provider:",
+                choices=[
+                    Choice(value="groq", name="Groq (recommended)"),
+                    Choice(value="gemini", name="Gemini"),
+                    Choice(value="ollama", name="Ollama (local)"),
+                ],
+                default="groq",
+                style=style,
+                show_cursor=False,
+            ).execute()
+
+            match provider:
+                case "groq":
+                    print()
+                    print(
+                        f"To get your forever-free Groq API key, head to {ACCENT}console.groq.com/keys{RESET}."
+                    )
+                    print(
+                        "Create an account and then create a new API key without an expiration date."
+                    )
+                    print("Then copy the API key and paste it here.")
+                case "gemini":
+                    print()
+                    pass
+                case "ollama":
+                    pass
+                case _:
+                    ai_activated = False
+                    provider = None
+                    api_key = None
+
+            if provider in ["groq", "gemini"]:
+                print()
+
+                # 3.2. Get API key
+                api_key = secret.SecretPrompt(
+                    message="Your API key:",
+                    style=style,
+                    vi_mode=True,
+                ).execute()
+            else:
+                api_key = None
+            print()
+
+            # 3.3. Select model
+            model = input.InputPrompt(
+                message="Enter the model you want to use:",
+                style=style,
+                vi_mode=True,
+            ).execute()
+
+        else:
+            model = None
+            provider = None
+            api_key = None
+
+        print()
+
+    except KeyboardInterrupt:
+        quit()
+
+    env_path = os.path.join(
+        appdirs.user_data_dir(appname="Comprobot", appauthor=False), ".env"
+    )
+    with open(env_path, "w") as f:
+        f.write(f"BOT_TOKEN={token}\n")
+        if api_key:
+            if provider == "groq":
+                f.write(f"GROQ={api_key}\n")
+                f.write("GEMINI=\n")
+            elif provider == "gemini":
+                f.write(f"GEMINI={api_key}\n")
+                f.write("GROQ=\n")
+        else:
+            f.write("GROQ=\n")
+            f.write("GEMINI=\n")
+
+    result = {
+        "token": token,
+        "commands_activated": commands_activated,
+        "ai_activated": ai_activated,
+        "provider": provider,
+        "api_key": api_key,
+        "model": model,
+    }
+
+    if config["debug_mode"]:
+        print()
+        print(json.dumps(result, indent=4))
+        print()
+
+    print(f"{ACCENT}You're all set!{RESET} Have fun using Comprobot!")
+
+    return result

{comprobot-2.0.4 → comprobot-2.1.0}/Comprobot/templates.py

@@ -118,20 +118,11 @@ mute   = []
 time_to_mute = 5 # In minutes
 """
 
-env_template = r"""BOT_TOKEN=
+env = r"""BOT_TOKEN=
 GEMINI=
 GROQ=
 """
 
-create_commands = r"""create("config.toml", config)
-create("error-messages.toml", error_messages)
-create("keywords.toml", keywords)
-create("ai.toml", ai)
-create("moderation.toml", moderation)
-create("data/.do_not_touch/money.toml", money)
-create("data/.do_not_touch/conversation_history.toml", conversation_history)
-create(".env", env_template)"""
-
 active = r"""quote             = true
 joke              = true
 meme              = true

{comprobot-2.0.4/comprobot.egg-info → comprobot-2.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: comprobot
-Version: 2.0.4
+Version: 2.1.0
 Summary: A self-hostable Discord bot built for maximum customization.
 Author: badluma
 License: MIT
@@ -19,10 +19,11 @@ Requires-Dist: appdirs
 Requires-Dist: ollama
 Requires-Dist: google-genai
 Requires-Dist: groq
+Requires-Dist: InqurererPy
 Provides-Extra: dev
 Requires-Dist: ruff; extra == "dev"
 
-## Description
+# Comprobot
 
 Comprobot is a highly-customizable, open-source Discord bot that you can run on your own server.
 

{comprobot-2.0.4 → comprobot-2.1.0}/README.md

@@ -1,4 +1,4 @@
-## Description
+# Comprobot
 
 Comprobot is a highly-customizable, open-source Discord bot that you can run on your own server.
 

{comprobot-2.0.4 → comprobot-2.1.0/comprobot.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: comprobot
-Version: 2.0.4
+Version: 2.1.0
 Summary: A self-hostable Discord bot built for maximum customization.
 Author: badluma
 License: MIT
@@ -19,10 +19,11 @@ Requires-Dist: appdirs
 Requires-Dist: ollama
 Requires-Dist: google-genai
 Requires-Dist: groq
+Requires-Dist: InqurererPy
 Provides-Extra: dev
 Requires-Dist: ruff; extra == "dev"
 
-## Description
+# Comprobot
 
 Comprobot is a highly-customizable, open-source Discord bot that you can run on your own server.
 

{comprobot-2.0.4 → comprobot-2.1.0}/comprobot.egg-info/SOURCES.txt

@@ -10,6 +10,7 @@ Comprobot/functions.py
 Comprobot/main.py
 Comprobot/moderation.py
 Comprobot/money_system.py
+Comprobot/onboarding.py
 Comprobot/process.py
 Comprobot/templates.py
 comprobot.egg-info/PKG-INFO

{comprobot-2.0.4 → comprobot-2.1.0}/comprobot.egg-info/requires.txt

@@ -6,6 +6,7 @@ appdirs
 ollama
 google-genai
 groq
+InqurererPy
 
 [dev]
 ruff

{comprobot-2.0.4 → comprobot-2.1.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "comprobot"
-version = "2.0.4"
+version = "2.1.0"
 authors = [{name = "badluma"}]
 description = "A self-hostable Discord bot built for maximum customization."
 readme = "README.md"
@@ -24,6 +24,7 @@ dependencies = [
     "ollama",
     "google-genai",
     "groq",
+    "InqurererPy",
 ]
 
 [project.optional-dependencies]

comprobot-2.0.4/Comprobot/__main__.py

@@ -1,4 +0,0 @@
-from .main import main
-
-if __name__ == "__main__":
-    main()

comprobot-2.0.4/Comprobot/data.py

@@ -1,84 +0,0 @@
-import os
-from typing import Any, Dict, List
-
-import appdirs
-import tomlkit
-
-from . import templates
-
-
-def _get_data_path(filename):
-
-    base_dir = appdirs.user_data_dir(appname="Comprobot", appauthor=False)
-    return os.path.join(base_dir, filename)
-
-
-def _ensure_file(path, content):
-
-    os.makedirs(os.path.dirname(path), exist_ok=True)
-    if not os.path.isfile(path):
-        with open(path, "w") as f:
-            f.write(content)
-
-
-def _merge_defaults(data, defaults):
-    for key, value in defaults.items():
-        if key not in data:
-            data[key] = value
-        elif isinstance(value, dict) and isinstance(data.get(key), dict):
-            _merge_defaults(data[key], value)
-
-
-def _load_or_create(path, template_content):
-    try:
-        with open(path, "rb") as f:
-            data = tomlkit.load(f)
-    except FileNotFoundError:
-        _ensure_file(path, template_content)
-        with open(path, "rb") as f:
-            data = tomlkit.load(f)
-
-    defaults = tomlkit.loads(template_content)
-    _merge_defaults(data, defaults)
-
-    if data != defaults:
-        with open(path, "w") as f:
-            tomlkit.dump(data, f)
-
-    return data
-
-
-error_messages: Dict[str, str] = _load_or_create(
-    _get_data_path("error-messages.toml"), templates.error_messages
-)
-config: Dict[str, Any] = _load_or_create(
-    _get_data_path("config.toml"), templates.config
-)
-keywords: Dict[str, Dict[str, List[str]]] = _load_or_create(
-    _get_data_path("keywords.toml"), templates.keywords
-)
-ai: Dict[str, Any] = _load_or_create(_get_data_path("ai.toml"), templates.ai)
-system_prompt_text = ai["system_prompt"]
-money: Dict[str, Dict[str, int]] = _load_or_create(
-    _get_data_path("money.toml"), r"""members = {}"""
-)
-active: Dict[str, bool] = _load_or_create(
-    _get_data_path("active.toml"), templates.active
-)
-output: Dict[str, Dict[str, List[str]]] = _load_or_create(
-    _get_data_path("output.toml"), templates.output
-)
-moderation: Dict[Any, Any] = _load_or_create(
-    _get_data_path("moderation.toml"), templates.moderation
-)
-
-_ensure_file(_get_data_path(".env"), templates.env_template)
-
-
-def save_toml(data, path):
-    with open(path, "w") as f:
-        tomlkit.dump(data, f)
-
-
-def save_money():
-    save_toml(money, _get_data_path("money.toml"))