Plugin Framework (#19)

* lots of changes, mostly cleaning, but also plugins

* replace magic values

* plugin examples wip

* character distinction in history

* better plugin examples

* better default character showcasing plugins

* modified defaults for clarity

* prepare for additional ai modules

* fix yaml

* more cleanup

* docstrings, bug fixes, and improvements

* separate core from modules

Author: ahokinson

.gitignore

@@ -159,9 +159,18 @@ cython_debug/
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 .idea/
 
-# Custom
+# Mac
+.DS_Store
+
+# Sierra
 temp/*
-*.sierra
+**/*.sierra
 **/secrets.yaml
-**/user_token.json
-.DS_Store
+
+# Prefix characters and tasks with . to avoid git tracking
+play/characters/!*
+play/tasks/!*
+
+ai/*/
+input/*/
+plugins/*/

ai/__init__.py

@@ -6,22 +6,35 @@
 
 
 class Function(Enum):
+    """
+    The different functions that can be called on an AI.
+    """
     CHAT = "Chat"
     SPEAK = "Speak"
     TRANSCRIBE = "Transcribe"
 
 
 class Role(Enum):
+    """
+    The different roles that an AI can have.
+    """
     ASSISTANT = "assistant"
     USER = "user"
     SYSTEM = "system"
 
 
-modules = {}
+ai = {}
 for ai_glob in glob(path.join('ai', '*')):
-    if isdir(ai_glob):
-        modules[path.split(ai_glob)[-1]] = import_module('.'.join(path.split(ai_glob)))
+    if isdir(ai_glob) and not ai_glob.startswith('_'):
+        if path.exists(path.join(ai_glob, '__init__.py')):
+            ai[path.split(ai_glob)[-1]] = import_module('.'.join(path.split(ai_glob)))
 
 
 def load(name, function):
-    return getattr(modules.get(name), function.value)
+    """
+    `load` function to load a function from an AI.
+    :param name:
+    :param function:
+    :return:
+    """
+    return getattr(ai.get(name), function.value)

ai/elevenlabs/__init__.py

@@ -1,5 +1,15 @@
-class Input:
+from uuid import uuid4
+
 
+class Input:
+    """
+    `Input` class to represent an input.
+    """
     def __init__(self, json):
-        self.character = json.get("character", None)
-        self.message = json.get("message", None)
+        """
+        :param json: dict
+        """
+        self.id = uuid4()
+        self.character = json.get('character', None)
+        self.message = json.get('message', None)
+        self.source = json.get('source', None)

ai/elevenlabs/requirements.txt

@@ -0,0 +1,3 @@
+git@github.com:point-and-click/elevenlabs.git
+git@github.com:point-and-click/open_ai.git
+git@github.com:point-and-click/play_ht.git