Merge pull request #49 from A-Baji/dev

3.0.3

Author: A-Baji

CHANGELOG.md

@@ -2,6 +2,14 @@
 
 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.3] - 07-1-2024
+
+### Changed
+
+- update env value handling
+- make command help strs dynamic
+- reorganize cli to allow reuse in parent
+
 ## [3.0.2] - 06-29-2024
 
 ### Added
@@ -95,6 +103,7 @@ Observes [Semantic Versioning](https://semver.org/spec/v2.0.0.html) standard and
 
 - switched to `pathlib` for file path parsing
 
+[3.0.3]: https://github.com/A-Baji/discordAI-modelizer/compare/3.0.2...3.0.3
 [3.0.2]: https://github.com/A-Baji/discordAI-modelizer/compare/3.0.1...3.0.2
 [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

Dockerfile

@@ -1,7 +1,6 @@
 ARG PY_VER
 FROM python:${PY_VER}
 WORKDIR /main
-RUN apt-get install git -y
 COPY ./requirements.txt ./setup.py ./README.md /main/
 COPY ./discordai_modelizer /main/discordai_modelizer
 RUN pip3 install --upgrade pip

discordai_modelizer/command_line/command_line.py

@@ -5,47 +5,43 @@
 from discordai_modelizer import customize
 from discordai_modelizer import openai as openai_wrapper
 from discordai_modelizer.command_line import subparsers
+from discordai_modelizer.command_line.subparsers import (
+    set_openai_help_str,
+    set_bot_key_help_str,
+)
 
 
-def discordai_modelizer():
-    parser = argparse.ArgumentParser(
-        prog="discordai_modelizer", description="DiscordAI Modelizer CLI"
-    )
-    parser.add_argument(
-        "-V", "--version", action="version", version=f"discordai {version}"
-    )
+def setup_modelizer_commands(parser, is_parent=False):
     command = parser.add_subparsers(dest="command")
 
-    model = command.add_parser(
-        "model", description="Commands related to your openAI models"
-    )
-    job = command.add_parser("job", description="Commands related to your openAI jobs")
+    model = command.add_parser("model", help="Manage your OpenAI models")
+    job = command.add_parser("job", help="Manage your OpenAI jobs")
 
     model_subcommand = model.add_subparsers(dest="subcommand")
     job_subcommand = job.add_subparsers(dest="subcommand")
 
-    subparsers.setup_model_list(model_subcommand)
-    subparsers.setup_model_create(model_subcommand)
-    subparsers.setup_model_delete(model_subcommand)
+    subparsers.setup_model_list(model_subcommand, is_parent)
+    subparsers.setup_model_create(model_subcommand, is_parent)
+    subparsers.setup_model_delete(model_subcommand, is_parent)
 
-    subparsers.setup_job_list(job_subcommand)
-    subparsers.setup_job_info(job_subcommand)
-    subparsers.setup_job_events(job_subcommand)
-    subparsers.setup_job_cancel(job_subcommand)
+    subparsers.setup_job_list(job_subcommand, is_parent)
+    subparsers.setup_job_info(job_subcommand, is_parent)
+    subparsers.setup_job_events(job_subcommand, is_parent)
+    subparsers.setup_job_cancel(job_subcommand, is_parent)
+
+    return command, model_subcommand, job_subcommand
 
-    args = parser.parse_args()
-    if hasattr(args, "openai_key"):
-        openai_wrapper.set_openai_api_key(args.openai_key)
 
+def read_modelizer_args(args, model_subcommand, job_subcommand):
     if args.command == "model":
         if args.subcommand == "list":
-            display(openai_wrapper.list_models(os.environ["OPENAI_API_KEY"], args.full))
+            display(openai_wrapper.list_models(args.openai_key, args.full))
         elif args.subcommand == "create":
             customize.create_model(
                 args.channel,
                 args.user,
                 args.discord_token,
-                os.environ["OPENAI_API_KEY"],
+                args.openai_key,
                 thought_time=args.thought_time,
                 thought_max=args.thought_max,
                 thought_min=args.thought_min,
@@ -59,39 +55,68 @@ def discordai_modelizer():
                 use_existing=args.use_existing,
             )
         elif args.subcommand == "delete":
-            display(
-                openai_wrapper.delete_model(args.model_id, os.environ["OPENAI_API_KEY"])
-            )
+            display(openai_wrapper.delete_model(args.model_id, args.openai_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(os.environ["OPENAI_API_KEY"], args.full))
+            display(openai_wrapper.list_jobs(args.openai_key, args.full))
         elif args.subcommand == "info":
-            display(
-                openai_wrapper.get_job_info(args.job_id, os.environ["OPENAI_API_KEY"])
-            )
+            display(openai_wrapper.get_job_info(args.job_id, args.openai_key))
         elif args.subcommand == "events":
-            display(
-                openai_wrapper.get_job_events(args.job_id, os.environ["OPENAI_API_KEY"])
-            )
+            display(openai_wrapper.get_job_events(args.job_id, args.openai_key))
         elif args.subcommand == "cancel":
-            display(
-                openai_wrapper.cancel_job(args.job_id, os.environ["OPENAI_API_KEY"])
-            )
+            display(openai_wrapper.cancel_job(args.job_id, args.openai_key))
         else:
             raise argparse.ArgumentError(
                 job_subcommand,
-                "Must choose a command from `info`, `events`, or `cancel`",
+                "Must choose a command from `list`, `info`, `events`, or `cancel`",
             )
 
 
 def display(obj):
     print(json.dumps(obj, indent=4))
 
 
+def set_openai_api_key(key: str, obj, is_parent=False):
+    if not key and not obj.get("OPENAI_API_KEY"):
+        raise ValueError(
+            f"Your OpenAI API key must either be passed in as an argument or set {set_openai_help_str(is_parent)}",
+        )
+    else:
+        return key or obj.get("OPENAI_API_KEY")
+
+
+def set_bot_token(token: str, obj, is_parent=False):
+    if not token and not obj.get("DISCORD_BOT_TOKEN"):
+        raise ValueError(
+            f"Your Discord bot token must either be passed in as an argument or set {set_bot_key_help_str(is_parent)}",
+        )
+    else:
+        return token or obj.get("DISCORD_BOT_TOKEN")
+
+
+def discordai_modelizer():
+    parser = argparse.ArgumentParser(
+        prog="discordai_modelizer", description="DiscordAI Modelizer CLI"
+    )
+    parser.add_argument(
+        "-V", "--version", action="version", version=f"discordai-modelizer {version}"
+    )
+
+    command, model_subcommand, job_subcommand = setup_modelizer_commands(parser)
+
+    args = parser.parse_args()
+    if hasattr(args, "openai_key"):
+        args.openai_key = set_openai_api_key(args.openai_key, os.environ)
+    if hasattr(args, "discord_token"):
+        args.discord_token = set_bot_token(args.discord_token, os.environ)
+
+    read_modelizer_args(args, model_subcommand, job_subcommand)
+
+
 if __name__ == "__main__":
     discordai_modelizer()

discordai_modelizer/command_line/subparsers.py

@@ -1,9 +1,14 @@
-from argparse import _SubParsersAction, ArgumentParser
+def set_openai_help_str(is_parent=False):
+    return f"{'in your config' if is_parent else 'as the OPENAI_API_KEY environment variable'}"
 
 
-def setup_model_list(model_subcommand):
+def set_bot_key_help_str(is_parent=False):
+    return f"{'in your config' if is_parent else 'as the DISCORD_BOT_TOKEN environment variable'}"
+
+
+def setup_model_list(model_subcommand, is_parent=False):
     model_list = model_subcommand.add_parser(
-        "list", description="List your openAi customized models"
+        "list", help="List your openAi customized models"
     )
     model_list_required_named = model_list.add_argument_group(
         "required named arguments"
@@ -17,7 +22,7 @@ def setup_model_list(model_subcommand):
         "--openai-key",
         type=str,
         dest="openai_key",
-        help="The openAI API key to list the models for. Must either be passed in as an argument or set as an environment variable",
+        help=f"The openAI API key to list the models for. Must either be passed in as an argument or set {set_openai_help_str(is_parent)}",
     )
     model_list_optional_named.add_argument(
         "--full",
@@ -28,10 +33,10 @@ def setup_model_list(model_subcommand):
     )
 
 
-def setup_model_create(model_subcommand):
+def setup_model_create(model_subcommand, is_parent=False):
     model_create = model_subcommand.add_parser(
         "create",
-        description="Create a new openAI customized model by downloading the specified chat logs, parsing them into a usable dataset, and then training a customized model using openai",
+        help="Create a new openAI customized model by downloading the specified chat logs, parsing them into a usable dataset, and then training a customized model using openai",
     )
     model_create_required_named = model_create.add_argument_group(
         "required named arguments"
@@ -45,14 +50,14 @@ def setup_model_create(model_subcommand):
         "--discord-token",
         type=str,
         dest="discord_token",
-        help="The discord token for your bot. Must either be passed in as an argument or set as an environment variable",
+        help=f"The discord token for your bot. Must either be passed in as an argument or set {set_bot_key_help_str(is_parent)}",
     )
     model_create_required_named.add_argument(
         "-o",
         "--openai-key",
         type=str,
         dest="openai_key",
-        help="The openAI API key to use to create the model. Must either be passed in as an argument or set as an environment variable",
+        help=f"The openAI API key to use to create the model. Must either be passed in as an argument or set {set_openai_help_str(is_parent)}",
     )
     model_create_required_named.add_argument(
         "-c",
@@ -164,10 +169,10 @@ def setup_model_create(model_subcommand):
     )
 
 
-def setup_model_delete(model_subcommand):
+def setup_model_delete(model_subcommand, is_parent=False):
     model_delete = model_subcommand.add_parser(
         "delete",
-        description="Delete an openAI customized model",
+        help="Delete an openAI customized model",
     )
     model_delete_required_named = model_delete.add_argument_group(
         "required named arguments"
@@ -178,7 +183,7 @@ def setup_model_delete(model_subcommand):
         "--openai-key",
         type=str,
         dest="openai_key",
-        help="The openAI API key associated with the model to delete. Must either be passed in as an argument or set as an environment variable",
+        help=f"The openAI API key associated with the model to delete. Must either be passed in as an argument or set {set_openai_help_str(is_parent)}",
     )
     model_delete_required_named.add_argument(
         "-m",
@@ -190,9 +195,9 @@ def setup_model_delete(model_subcommand):
     )
 
 
-def setup_job_list(job_subcommand):
+def setup_job_list(job_subcommand, is_parent=False):
     job_list = job_subcommand.add_parser(
-        "list", description="List your openAI customization jobs"
+        "list", help="List your openAI customization jobs"
     )
     job_list_required_named = job_list.add_argument_group("required named arguments")
     job_list_optional_named = job_list.add_argument_group("optional named arguments")
@@ -202,7 +207,7 @@ def setup_job_list(job_subcommand):
         "--openai-key",
         type=str,
         dest="openai_key",
-        help="The openAI API key to list the jobs for. Must either be passed in as an argument or set as an environment variable",
+        help=f"The openAI API key to list the jobs for. Must either be passed in as an argument or set {set_openai_help_str(is_parent)}",
     )
     job_list_optional_named.add_argument(
         "--full",
@@ -213,9 +218,9 @@ def setup_job_list(job_subcommand):
     )
 
 
-def setup_job_info(job_subcommand):
+def setup_job_info(job_subcommand, is_parent=False):
     job_info = job_subcommand.add_parser(
-        "info", description="Get an openAI customization job's info"
+        "info", help="Get an openAI customization job's info"
     )
     job_info_required_named = job_info.add_argument_group("required named arguments")
 
@@ -224,7 +229,7 @@ def setup_job_info(job_subcommand):
         "--openai-key",
         type=str,
         dest="openai_key",
-        help="The openAI API key associated with the job to see the info for. Must either be passed in as an argument or set as an environment variable",
+        help=f"The openAI API key associated with the job to see the info for. Must either be passed in as an argument or set {set_openai_help_str(is_parent)}",
     )
     job_info_required_named.add_argument(
         "-j",
@@ -236,9 +241,9 @@ def setup_job_info(job_subcommand):
     )
 
 
-def setup_job_events(job_subcommand):
+def setup_job_events(job_subcommand, is_parent=False):
     job_events = job_subcommand.add_parser(
-        "events", description="Get an openAI customization job's events"
+        "events", help="Get an openAI customization job's events"
     )
     job_events_required_named = job_events.add_argument_group(
         "required named arguments"
@@ -249,7 +254,7 @@ def setup_job_events(job_subcommand):
         "--openai-key",
         type=str,
         dest="openai_key",
-        help="The openAI API key associated with the job to see the events for. Must either be passed in as an argument or set as an environment variable",
+        help=f"The openAI API key associated with the job to see the events for. Must either be passed in as an argument or set {set_openai_help_str(is_parent)}",
     )
     job_events_required_named.add_argument(
         "-j",
@@ -261,9 +266,9 @@ def setup_job_events(job_subcommand):
     )
 
 
-def setup_job_cancel(job_subcommand):
+def setup_job_cancel(job_subcommand, is_parent=False):
     job_cancel = job_subcommand.add_parser(
-        "cancel", description="Cancel an openAI customization job"
+        "cancel", help="Cancel an openAI customization job"
     )
     job_cancel_required_named = job_cancel.add_argument_group(
         "required named arguments"
@@ -274,7 +279,7 @@ def setup_job_cancel(job_subcommand):
         "--openai-key",
         type=str,
         dest="openai_key",
-        help="The openAI API key associated with the job to cancel. Must either be passed in as an argument or set as an environment variable",
+        help=f"The openAI API key associated with the job to cancel. Must either be passed in as an argument or set {set_openai_help_str(is_parent)}",
     )
     job_cancel_required_named.add_argument(
         "-j",