feat: updated instance docstring for db emitter

process_bigraph/emitter.py

@@ -40,19 +40,21 @@ class Emitter(Step):
     def query(self, query=None):
         return {}
 
+    def update(self, state) -> Dict:
+        return {}
+
 
 class ConsoleEmitter(Emitter):
     config_schema = {
         'ports': 'tree[any]'}
 
 
-    def schema(self):
+    def schema(self) -> Dict:
         return self.config['ports']
 
 
-    def update(self, state):
+    def update(self, state) -> Dict:
         print(state)
-
         return {}
 
 
@@ -67,11 +69,11 @@ def __init__(self, config):
         self.history = []
 
 
-    def schema(self):
+    def schema(self) -> Dict:
         return self.config['ports']
 
 
-    def update(self, state):
+    def update(self, state) -> Dict:
         self.history.append(copy.deepcopy(state))
 
         return {}
@@ -101,6 +103,17 @@ class DatabaseEmitter(Emitter):
     ... }
     >>> # The line below works only if you have to have 27017 open locally
     >>> # emitter = DatabaseEmitter(config)
+
+    PLEASE NOTE: For Mac Silicon, you can start a Mongo instance as a background process with:
+
+        ``mongod --config /opt/homebrew/etc/mongod.conf --fork``
+
+        ...and the process can be stopped in two ways:
+
+            1.) `kill {PID}`
+
+            2.) `mongosh -> use admin -> db.shutdownServer()`
+
     """
     default_host = 'localhost:27017'
     client_dict: Dict[int, MongoClient] = {}
@@ -204,6 +217,9 @@ def update(self, state):
 
         return {}
 
+    def schema(self) -> Dict:
+        return self.config['ports']
+
 
 def make_fallback_serializer_function() -> Callable:
     """Creates a fallback function that is called by orjson on data of
@@ -628,3 +644,8 @@ def get_local_client(host: str, port: Any, database_name: str) -> Any:
     """Open a MongoDB client onto the given host, port, and DB."""
     client: MongoClient = MongoClient('{}:{}'.format(host, port))
     return client[database_name]
+
+
+emitter = DatabaseEmitter(config={})
+
+print(dir(emitter))