proscenium 0.0.6__py3-none-any.whl → 0.0.8__py3-none-any.whl

proscenium/bin/__init__.py

@@ -0,0 +1,42 @@
+from typing import Callable, Optional
+
+import logging
+import importlib
+import yaml
+from pathlib import Path
+from rich.console import Console
+from proscenium.core import Production
+
+logging.getLogger(__name__).addHandler(logging.NullHandler())
+
+
+def load_config(config_file_name: Path) -> dict:
+
+    if not config_file_name.exists():
+        raise FileNotFoundError(
+            f"Configuration file {config_file_name} not found. "
+            "Please provide a valid configuration file."
+        )
+
+    with open(config_file_name, "r", encoding="utf-8") as f:
+        config = yaml.safe_load(f)
+        return config
+
+
+def production_from_config(
+    config_file_name: Path,
+    get_secret: Callable[[str, str], str],
+    sub_console: Optional[Console] = None,
+) -> tuple[Production, dict]:
+
+    config = load_config(config_file_name)
+
+    production_config = config.get("production", {})
+
+    production_module_name = production_config.get("module", None)
+
+    production_module = importlib.import_module(production_module_name, package=None)
+
+    production = production_module.make_production(config, get_secret, sub_console)
+
+    return production, config

proscenium/bin/bot.py

@@ -4,32 +4,12 @@ import os
 import sys
 import logging
 import typer
-import importlib
+from pathlib import Path
 from rich.console import Console
 
-from proscenium.admin import Admin
-
-from proscenium.interfaces.slack import (
-    get_slack_auth,
-    channel_table,
-    bot_user_id,
-    places_table,
-    channel_maps,
-    make_slack_listener,
-    connect,
-    send_curtain_up,
-    listen,
-    send_curtain_down,
-    shutdown,
-)
-
 from proscenium.verbs.display import header
-
-logging.basicConfig(
-    stream=sys.stdout,
-    format="%(asctime)s  %(levelname)-8s %(name)s: %(message)s",
-    level=logging.WARNING,
-)
+from proscenium.bin import production_from_config
+from proscenium.interfaces.slack import slack_main
 
 logging.basicConfig(
     stream=sys.stdout,
@@ -41,17 +21,16 @@ app = typer.Typer(help="Proscenium Bot")
 
 log = logging.getLogger(__name__)
 
+default_config_path = Path("demo/demo.yml")
+
 
 @app.command(help="""Start the Proscenium Bot.""")
 def start(
-    verbose: bool = False,
-    production_module_name: str = typer.Option(
-        "demo.production",
-        "-p",
-        "--production",
-        help="The name of the python module in PYTHONPATH in which the variable production of type proscenium.core.Production is defined.",
+    config_file: Path = typer.Option(
+        default_config_path,
+        help="The name of the Proscenium YAML configuration file.",
     ),
-    force_rebuild: bool = False,
+    verbose: bool = False,
 ):
 
     console = Console()
@@ -65,76 +44,15 @@ def start(
 
     console.print(header())
 
-    production_module = importlib.import_module(production_module_name, package=None)
-
-    slack_admin_channel_id = os.environ.get("SLACK_ADMIN_CHANNEL_ID")
-    # Note that the checking of the existence of the admin channel id is delayed
-    # until after the subscribed channels are shown.
-
-    production = production_module.make_production(slack_admin_channel_id, sub_console)
+    production, config = production_from_config(
+        config_file, os.environ.get, sub_console
+    )
 
     console.print("Preparing props...")
     production.prepare_props()
     console.print("Props are up-to-date.")
 
-    slack_app_token, slack_bot_token = get_slack_auth()
-
-    socket_mode_client = connect(slack_app_token, slack_bot_token)
-
-    user_id = bot_user_id(socket_mode_client, console)
-    console.print()
-
-    channels_by_id, channel_name_to_id = channel_maps(socket_mode_client)
-    console.print(channel_table(channels_by_id))
-    console.print()
-
-    if slack_admin_channel_id is None:
-        raise ValueError(
-            "SLACK_ADMIN_CHANNEL_ID environment variable not set. "
-            "Please set it to the channel ID of the Proscenium admin channel."
-        )
-    if slack_admin_channel_id not in channels_by_id:
-        raise ValueError(
-            f"Admin channel {slack_admin_channel_id} not found in subscribed channels."
-        )
-
-    admin = Admin(slack_admin_channel_id)
-    log.info("Admin handler started.")
-
-    log.info("Places, please!")
-    channel_id_to_character = production.places(channel_name_to_id)
-    channel_id_to_character[slack_admin_channel_id] = admin
-
-    console.print(places_table(channel_id_to_character, channels_by_id))
-    console.print()
-
-    slack_listener = make_slack_listener(
-        user_id,
-        slack_admin_channel_id,
-        channels_by_id,
-        channel_id_to_character,
-        console,
-    )
-
-    send_curtain_up(socket_mode_client, production, slack_admin_channel_id)
-
-    console.print("Starting the show. Listening for events...")
-    listen(
-        socket_mode_client,
-        slack_listener,
-        user_id,
-        console,
-    )
-
-    send_curtain_down(socket_mode_client, slack_admin_channel_id)
-
-    shutdown(
-        socket_mode_client,
-        slack_listener,
-        user_id,
-        production,
-        console,
-    )
+    slack_main(production, config, console)
 
 
 if __name__ == "__main__":

proscenium/interfaces/slack.py

@@ -1,6 +1,6 @@
 from typing import Callable
-
 from typing import Generator
+
 import time
 import logging
 import os
@@ -15,6 +15,7 @@ from slack_sdk.socket_mode.listeners import SocketModeRequestListener
 
 from proscenium.core import Production
 from proscenium.core import Character
+from proscenium.admin import Admin
 
 log = logging.getLogger(__name__)
 
@@ -277,3 +278,74 @@ def shutdown(
     production.curtain()
 
     console.print("Handlers stopped.")
+
+
+def slack_main(
+    production: Production,
+    config: dict,
+    console: Console,
+) -> None:
+
+    slack_app_token, slack_bot_token = get_slack_auth()
+
+    socket_mode_client = connect(slack_app_token, slack_bot_token)
+
+    user_id = bot_user_id(socket_mode_client, console)
+    console.print()
+
+    channels_by_id, channel_name_to_id = channel_maps(socket_mode_client)
+    console.print(channel_table(channels_by_id))
+    console.print()
+
+    slack_admin_channel = config.get("slack", {}).get("admin_channel", None)
+
+    if slack_admin_channel is None:
+        raise ValueError(
+            "slack.admin_channel is not set. "
+            "Please set it to the channel name of the Proscenium admin channel."
+        )
+    slack_admin_channel_id = channel_name_to_id.get(slack_admin_channel, None)
+    if slack_admin_channel_id is None:
+        raise ValueError(
+            f"Admin channel {slack_admin_channel} not found in subscribed channels."
+        )
+
+    admin = Admin(slack_admin_channel_id)
+    log.info(
+        "Admin handler started %s %s.", slack_admin_channel, slack_admin_channel_id
+    )
+
+    log.info("Places, please!")
+    channel_id_to_character = production.places(channel_name_to_id)
+    channel_id_to_character[slack_admin_channel_id] = admin
+
+    console.print(places_table(channel_id_to_character, channels_by_id))
+    console.print()
+
+    slack_listener = make_slack_listener(
+        user_id,
+        slack_admin_channel_id,
+        channels_by_id,
+        channel_id_to_character,
+        console,
+    )
+
+    send_curtain_up(socket_mode_client, production, slack_admin_channel_id)
+
+    console.print("Starting the show. Listening for events...")
+    listen(
+        socket_mode_client,
+        slack_listener,
+        user_id,
+        console,
+    )
+
+    send_curtain_down(socket_mode_client, slack_admin_channel_id)
+
+    shutdown(
+        socket_mode_client,
+        slack_listener,
+        user_id,
+        production,
+        console,
+    )

proscenium/util/__init__.py

@@ -0,0 +1,26 @@
+import logging
+import os
+
+logging.getLogger(__name__).addHandler(logging.NullHandler())
+
+log = logging.getLogger(__name__)
+
+
+def get_secret(key: str, default: str = None) -> str:
+    try:
+        from google.colab import userdata
+
+        try:
+            value = userdata.get(key)
+            os.environ[key] = value
+            log.info(
+                f"In colab. Read {key} from colab userdata and set os.environ value"
+            )
+            return value
+        except userdata.SecretNotFoundError:
+            return default
+    except ImportError:
+        if key in os.environ:
+            return os.environ.get(key, default)
+        else:
+            return default

{proscenium-0.0.6.dist-info → proscenium-0.0.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: proscenium
-Version: 0.0.6
+Version: 0.0.8
 Summary: Frame AI Agents
 License: ASFv2
 Author: Adam Pingel

{proscenium-0.0.6.dist-info → proscenium-0.0.8.dist-info}/RECORD

@@ -1,9 +1,10 @@
 proscenium/__init__.py,sha256=nDWNd6_TSf4vDQuHVBoAf4QfZCB3ZUFQ0M7XvifNJ-g,78
 proscenium/admin/__init__.py,sha256=GqGrkf7NOm3inuo67xszkARXZYKDsDs2jHuZh1tF4n0,924
-proscenium/bin/bot.py,sha256=nK4WN8ggpCr_KDpDI16Ib8RljmMpJyZ8qZTW8j7lwP4,3700
+proscenium/bin/__init__.py,sha256=ThVsDG6BmnZ86gYaZLGMDcNmR6fVwBLJG3k_JawfzOY,1160
+proscenium/bin/bot.py,sha256=kdZBe1SGM-S3-QSN-DM-_UnGwe6W5D32s-dTuczIPCU,1358
 proscenium/core/__init__.py,sha256=aSUqPMn2LjZ0C_l9Tx6yqqlfCzM7oSljZxHosJyjlLU,4335
 proscenium/interfaces/__init__.py,sha256=nDWNd6_TSf4vDQuHVBoAf4QfZCB3ZUFQ0M7XvifNJ-g,78
-proscenium/interfaces/slack.py,sha256=Arv3JT91gTZ_ZzizsOa9u1Wbbs8CnORr-KUzJzluy3g,8591
+proscenium/interfaces/slack.py,sha256=wjkdhqAHgISxdNG5Pwo-8_QIyQf76X7b-0WwZfNabI8,10600
 proscenium/patterns/__init__.py,sha256=nDWNd6_TSf4vDQuHVBoAf4QfZCB3ZUFQ0M7XvifNJ-g,78
 proscenium/patterns/chunk_space.py,sha256=kQzGUtkQKGQGzGjBqS7jz_zr3uvJeiCBD2leflOenM8,1635
 proscenium/patterns/document_enricher.py,sha256=u-Q4FwvNAFj9nday235jUwxIwizht_VAW8DsmNQmoJs,2374
@@ -12,6 +13,7 @@ proscenium/patterns/graph_rag.py,sha256=1HH1xdlAA6ypvYdP4dWFm-KXrGPUmm0T4qIdAU8m
 proscenium/patterns/knowledge_graph.py,sha256=VLjG8Rp7YfJLZKe9bZt2d4NsGloBV1AYI6SuaQtRLhs,1137
 proscenium/patterns/rag.py,sha256=zvl_P48F3PDfVMgRXeiClLlevMsPKCMA1teVq9X20OE,1494
 proscenium/patterns/tools.py,sha256=f2CD6f7CYiSs0Tm1Ff1sOL5Ti6DqJ5HQvMI7NmIgqNs,1740
+proscenium/util/__init__.py,sha256=FC1hjA37VvmVpF9-OlYNp9TjArH6etr6KiAvF9t_6lI,679
 proscenium/verbs/__init__.py,sha256=nDWNd6_TSf4vDQuHVBoAf4QfZCB3ZUFQ0M7XvifNJ-g,78
 proscenium/verbs/chunk.py,sha256=hlVHfuR7sEAR8euh3FRd8hb2eJozE7bHe-E0RmAoFP8,1106
 proscenium/verbs/complete.py,sha256=Y1T49OfAV7K8p0DMzE4aVqtkgVfjUqb6IeOazzdYGow,5071
@@ -27,8 +29,8 @@ proscenium/verbs/read.py,sha256=twFtcuyP-y-UwksLmGMCOjMqI7mp--VgvkGDfga6IxA,1262
 proscenium/verbs/remember.py,sha256=Hh9BDRAYf7MGeMD4MzU73p6Q28KrSiLWPx4GjTW1amQ,296
 proscenium/verbs/vector_database.py,sha256=U09P7jnpzUDeP7pEgJubf8xQsxC-O8Qb0MS0KY8eoe8,3527
 proscenium/verbs/write.py,sha256=0GUJuixLnuu_EbFFzAIgrhLEQnOrL0TdUlMiqOl9KtA,367
-proscenium-0.0.6.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-proscenium-0.0.6.dist-info/METADATA,sha256=WZh8drFgtCqfuL_F6PGn9CvZUvILgsGmYZv3lUzqmXE,2487
-proscenium-0.0.6.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-proscenium-0.0.6.dist-info/entry_points.txt,sha256=Q05DVkPq_SjgD8mFN6bG5ae2r_UbsqKCdy2kDAtHYGU,57
-proscenium-0.0.6.dist-info/RECORD,,
+proscenium-0.0.8.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+proscenium-0.0.8.dist-info/METADATA,sha256=A4wvRR5YW3DZlBrFXcm8d5P9OPkUB6jlSSRUS67XWi0,2487
+proscenium-0.0.8.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+proscenium-0.0.8.dist-info/entry_points.txt,sha256=Q05DVkPq_SjgD8mFN6bG5ae2r_UbsqKCdy2kDAtHYGU,57
+proscenium-0.0.8.dist-info/RECORD,,