proscenium 0.0.6__tar.gz → 0.0.8__tar.gz

{proscenium-0.0.6 → proscenium-0.0.8}/PKG-INFO

@@ -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.8/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-0.0.8/proscenium/bin/bot.py

@@ -0,0 +1,60 @@
+#!/usr/bin/env python3
+
+import os
+import sys
+import logging
+import typer
+from pathlib import Path
+from rich.console import Console
+
+from proscenium.verbs.display import header
+from proscenium.bin import production_from_config
+from proscenium.interfaces.slack import slack_main
+
+logging.basicConfig(
+    stream=sys.stdout,
+    format="%(asctime)s  %(levelname)-8s %(name)s: %(message)s",
+    level=logging.WARNING,
+)
+
+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(
+    config_file: Path = typer.Option(
+        default_config_path,
+        help="The name of the Proscenium YAML configuration file.",
+    ),
+    verbose: bool = False,
+):
+
+    console = Console()
+    sub_console = None
+
+    if verbose:
+        log.setLevel(logging.INFO)
+        logging.getLogger("proscenium").setLevel(logging.INFO)
+        logging.getLogger("demo").setLevel(logging.INFO)
+        sub_console = console
+
+    console.print(header())
+
+    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_main(production, config, console)
+
+
+if __name__ == "__main__":
+
+    app()

{proscenium-0.0.6 → proscenium-0.0.8}/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-0.0.8/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 → proscenium-0.0.8}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "proscenium"
-version = "0.0.6"
+version = "0.0.8"
 description = "Frame AI Agents"
 authors = ["Adam Pingel <oss@pingel.org>"]
 license = "ASFv2"

proscenium-0.0.6/proscenium/bin/bot.py

@@ -1,142 +0,0 @@
-#!/usr/bin/env python3
-
-import os
-import sys
-import logging
-import typer
-import importlib
-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,
-)
-
-logging.basicConfig(
-    stream=sys.stdout,
-    format="%(asctime)s  %(levelname)-8s %(name)s: %(message)s",
-    level=logging.WARNING,
-)
-
-app = typer.Typer(help="Proscenium Bot")
-
-log = logging.getLogger(__name__)
-
-
-@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.",
-    ),
-    force_rebuild: bool = False,
-):
-
-    console = Console()
-    sub_console = None
-
-    if verbose:
-        log.setLevel(logging.INFO)
-        logging.getLogger("proscenium").setLevel(logging.INFO)
-        logging.getLogger("demo").setLevel(logging.INFO)
-        sub_console = console
-
-    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)
-
-    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,
-    )
-
-
-if __name__ == "__main__":
-
-    app()