Merge pull request #47 from A-Baji/dev

3.0.1

Author: A-Baji

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 Observes [Semantic Versioning](https://semver.org/spec/v2.0.0.html) standard and [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) convention.
 
+## [3.0.1] - 06-27-2024
+
+### Changed
+
+- improve cli argument handling
+
 ## [3.0.0] - 06-26-2024
 
 ### Added
@@ -75,6 +81,7 @@ Observes [Semantic Versioning](https://semver.org/spec/v2.0.0.html) standard and
 
 - switched to `pathlib` for file path parsing
 
+[3.0.1]: https://github.com/A-Baji/discordAI-modelizer/compare/3.0.0...3.0.1
 [3.0.0]: https://github.com/A-Baji/discordAI-modelizer/compare/2.0.1...3.0.0
 [2.0.1]: https://github.com/A-Baji/discordAI-modelizer/compare/1.2.2...2.0.1
 [2.0.0]: https://github.com/A-Baji/discordAI-modelizer/compare/1.2.2...2.0.0

discordai_modelizer/command_line/command_line.py

@@ -1,5 +1,6 @@
 import argparse
 import json
+import os
 from discordai_modelizer import __version__ as version
 from discordai_modelizer import customize
 from discordai_modelizer import openai as openai_wrapper
@@ -33,13 +34,21 @@ def discordai_modelizer():
     subparsers.setup_job_cancel(job_subcommand)
 
     args = parser.parse_args()
+    try:
+        os.environ["OPENAI_API_KEY"] = args.openai_key or os.environ["OPENAI_API_KEY"]
+    except KeyError:
+        raise argparse.ArgumentError(
+            None,
+            "Your OpenaAI API key must either be passed in as an argument or set as an environment variable",
+        )
+
     if args.command == "model":
         if args.subcommand == "list":
-            display(openai_wrapper.list_models(args.openai_key, args.full))
-        if args.subcommand == "create":
+            display(openai_wrapper.list_models(os.environ["OPENAI_API_KEY"], args.full))
+        elif args.subcommand == "create":
             customize.create_model(
                 args.discord_token,
-                args.openai_key,
+                os.environ["OPENAI_API_KEY"],
                 args.channel,
                 args.user,
                 thought_time=args.thought_time,
@@ -54,17 +63,38 @@ def discordai_modelizer():
                 redownload=args.redownload,
                 use_existing=args.use_existing,
             )
-        if args.subcommand == "delete":
-            display(openai_wrapper.delete_model(args.openai_key, args.model_id))
+        elif args.subcommand == "delete":
+            display(
+                openai_wrapper.delete_model(args.model_id, os.environ["OPENAI_API_KEY"])
+            )
+        else:
+            raise argparse.ArgumentError(
+                model_subcommand,
+                "Must choose a command from `list`, `create`, or `delete`",
+            )
     elif args.command == "job":
         if args.subcommand == "list":
-            display(openai_wrapper.list_jobs(args.openai_key, args.full))
-        if args.subcommand == "info":
-            display(openai_wrapper.get_job_info(args.openai_key, args.job_id))
-        if args.subcommand == "events":
-            display(openai_wrapper.get_job_events(args.openai_key, args.job_id))
-        if args.subcommand == "cancel":
-            display(openai_wrapper.cancel_job(args.openai_key, args.job_id))
+            display(openai_wrapper.list_jobs(os.environ["OPENAI_API_KEY"], args.full))
+        elif args.subcommand == "info":
+            display(
+                openai_wrapper.get_job_info(args.job_id, os.environ["OPENAI_API_KEY"])
+            )
+        elif args.subcommand == "events":
+            display(
+                openai_wrapper.get_job_events(args.job_id, os.environ["OPENAI_API_KEY"])
+            )
+        elif args.subcommand == "cancel":
+            display(
+                openai_wrapper.cancel_job(args.job_id, os.environ["OPENAI_API_KEY"])
+            )
+            display(
+                openai_wrapper.delete_model(args.model_id, os.environ["OPENAI_API_KEY"])
+            )
+        else:
+            raise argparse.ArgumentError(
+                job_subcommand,
+                "Must choose a command from `info`, `events`, or `cancel`",
+            )
 
 
 def display(obj):

discordai_modelizer/command_line/subparsers.py

@@ -1,3 +1,6 @@
+from argparse import _SubParsersAction, ArgumentParser
+
+
 def setup_model_list(model_subcommand):
     model_list = model_subcommand.add_parser(
         "list", description="List your openAi customized models"
@@ -42,7 +45,7 @@ def setup_model_create(model_subcommand):
         "--discord-token",
         type=str,
         dest="discord_token",
-        help="The discord token for your bot",
+        help="The discord token for your bot. Must either be passed in as an argument or set as an environment variable",
     )
     model_create_required_named.add_argument(
         "-o",
@@ -54,13 +57,15 @@ def setup_model_create(model_subcommand):
     model_create_required_named.add_argument(
         "-c",
         "--channel",
+        required=True,
         type=str,
         dest="channel",
         help="The ID of the discord channel you want to use",
     )
     model_create_required_named.add_argument(
         "-u",
         "--user",
+        required=True,
         type=str,
         dest="user",
         help="The unique username of the discord user you want to use",
@@ -178,6 +183,7 @@ def setup_model_delete(model_subcommand):
     model_delete_required_named.add_argument(
         "-m",
         "--model-id",
+        required=True,
         type=str,
         dest="model_id",
         help="Target model id",
@@ -223,6 +229,7 @@ def setup_job_info(job_subcommand):
     job_info_required_named.add_argument(
         "-j",
         "--job-id",
+        required=True,
         type=str,
         dest="job_id",
         help="Target job id",
@@ -247,6 +254,7 @@ def setup_job_events(job_subcommand):
     job_events_required_named.add_argument(
         "-j",
         "--job-id",
+        required=True,
         type=str,
         dest="job_id",
         help="Target job id",
@@ -271,6 +279,7 @@ def setup_job_cancel(job_subcommand):
     job_cancel_required_named.add_argument(
         "-j",
         "--job-id",
+        required=True,
         type=str,
         dest="job_id",
         help="Target job id",

discordai_modelizer/customize.py

@@ -5,6 +5,7 @@
 import pathlib
 
 from openai import OpenAI
+from argparse import ArgumentError
 from discordai_modelizer.gen_dataset import parse_logs, get_lines
 
 MODEL_MAP = {
@@ -30,7 +31,6 @@ def create_model(
     redownload=False,
     use_existing=False,
 ):
-    os.environ["OPENAI_API_KEY"] = openai_key or os.environ["OPENAI_API_KEY"]
     client = OpenAI()
     channel_user = f"{channel_id[:4]}_{user_id}"
     files_path = pathlib.Path(appdirs.user_data_dir(appname="discordai"))
@@ -43,6 +43,14 @@ def create_model(
 
     # Download logs
     if (not os.path.isfile(full_logs_path) or redownload) and not use_existing:
+        try:
+            bot_token = bot_token or os.environ["DISCORD_BOT_TOKEN"]
+        except KeyError:
+            raise ArgumentError(
+                None,
+                "Your Discord bot token must either be passed in as an argument or set as an environment variable",
+            )
+
         print("INFO: Exporting chat logs using DiscordChatExporter...")
         print(
             "INFO: This may take a few minutes to hours depending on the message count of the channel"

discordai_modelizer/openai.py

@@ -16,8 +16,17 @@ def convert_in_place(obj, key: str):
     return obj
 
 
-def list_jobs(openai_key: str, full=False) -> list[dict]:
-    os.environ["OPENAI_API_KEY"] = openai_key or os.environ["OPENAI_API_KEY"]
+def set_openai_api_key(key: str):
+    try:
+        os.environ["OPENAI_API_KEY"] = key or os.environ["OPENAI_API_KEY"]
+    except KeyError:
+        raise ValueError(
+            "Your OpenaAI API key must either be passed in as an argument or set as an environment variable",
+        )
+
+
+def list_jobs(openai_key: str = None, full=False) -> list[dict]:
+    set_openai_api_key(openai_key)
     client = OpenAI()
     finetunes = client.fine_tuning.jobs.list()
     client.close()
@@ -48,8 +57,8 @@ def list_jobs(openai_key: str, full=False) -> list[dict]:
         ]
 
 
-def list_models(openai_key: str, full=False) -> list[dict]:
-    os.environ["OPENAI_API_KEY"] = openai_key or os.environ["OPENAI_API_KEY"]
+def list_models(openai_key: str = None, full=False) -> list[dict]:
+    set_openai_api_key(openai_key)
     client = OpenAI()
     finetunes = client.models.list()
     client.close()
@@ -62,8 +71,8 @@ def list_models(openai_key: str, full=False) -> list[dict]:
         ]
 
 
-def get_job_info(openai_key: str, job_id: str) -> dict:
-    os.environ["OPENAI_API_KEY"] = openai_key or os.environ["OPENAI_API_KEY"]
+def get_job_info(job_id: str, openai_key: str = None) -> dict:
+    set_openai_api_key(openai_key)
     client = OpenAI()
     job = client.fine_tuning.jobs.retrieve(job_id)
     client.close()
@@ -77,8 +86,8 @@ def get_job_info(openai_key: str, job_id: str) -> dict:
     )
 
 
-def get_job_events(openai_key: str, job_id: str) -> list[dict]:
-    os.environ["OPENAI_API_KEY"] = openai_key or os.environ["OPENAI_API_KEY"]
+def get_job_events(job_id: str, openai_key: str = None) -> list[dict]:
+    set_openai_api_key(openai_key)
     client = OpenAI()
     events = client.fine_tuning.jobs.list_events(job_id).data
     client.close()
@@ -91,22 +100,22 @@ def get_job_events(openai_key: str, job_id: str) -> list[dict]:
     ]
 
 
-def cancel_job(openai_key: str, job_id: str) -> dict:
-    os.environ["OPENAI_API_KEY"] = openai_key or os.environ["OPENAI_API_KEY"]
+def cancel_job(job_id: str, openai_key: str = None) -> dict:
+    set_openai_api_key(openai_key)
     client = OpenAI()
     client.fine_tuning.jobs.cancel(job_id)
     client.close()
     return {"result": f"Canceled fine-tuning job: {job_id}"}
 
 
-def delete_model(openai_key: str, model_name: str) -> dict:
+def delete_model(model_name: str, openai_key: str = None) -> dict:
     confirm = input(
         "Are you sure you want to delete this model? This action is not reversable. Y/N: "
     )
     if confirm.lower() not in ["y", "yes"]:
         print("Cancelling model deletion...")
         return
-    os.environ["OPENAI_API_KEY"] = openai_key or os.environ["OPENAI_API_KEY"]
+    set_openai_api_key(openai_key)
     client = OpenAI()
     deleted = client.models.delete(model_name).model_dump()
     client.close()

discordai_modelizer/version.py

@@ -1 +1 @@
-__version__ = "3.0.0"
+__version__ = "3.0.1"

docker-compose.yaml

@@ -1,7 +1,7 @@
 # VERSION=$(cat discordai_modelizer/version.py | grep -oP '\d+\.\d+\.\d+') docker compose up --build
 # docker exec -it discordai-modelizer-app-1 bash
 # discordai_modelizer model list --full
-# discordai_modelizer model create -d $DISCORD_TOKEN -c $CHANNEL_ID -u "$USERNAME"
+# discordai_modelizer model create -d $DISCORD_BOT_TOKEN -c $CHANNEL_ID -u "$USERNAME"
 # discordai_modelizer model delete -m ""
 # discordai_modelizer job list --full
 # discordai_modelizer job info -j ftjob-SDOuDLTs6a7xu9LMzdhJKo9w --events
@@ -14,14 +14,14 @@ services:
     network_mode: host
     working_dir: /main
     environment:
-      - DISCORD_TOKEN
+      - DISCORD_BOT_TOKEN
       - OPENAI_API_KEY
       - CHANNEL_ID
       - USERNAME
       - PYTHONUNBUFFERED=1
     env_file: ./.env
     volumes:
-      - ./discordai_modelizer:/usr/local/lib/python3.11/site-packages/discordai_modelizer
+      - ./discordai_modelizer:/usr/local/lib/python3.12/site-packages/discordai_modelizer
       - ./files/:/root/.local/share/discordai/
     command:
       - sh