koi-net 1.0.0b17__py3-none-any.whl → 1.0.0b19__py3-none-any.whl

koi_net/config.py

@@ -13,7 +13,7 @@ class ServerConfig(BaseModel):
     path: str | None = "/koi-net"
     
     @property
-    def url(self):
+    def url(self) -> str:
         return f"http://{self.host}:{self.port}{self.path or ''}"
 
 class KoiNetConfig(BaseModel):

koi_net/processor/default_handlers.py

@@ -134,6 +134,10 @@ def coordinator_contact(processor: ProcessorInterface, kobj: KnowledgeObject):
     if KoiNetNode not in node_profile.provides.event:
         return
     
+    # prevents coordinators from attempting to form a self loop
+    if kobj.rid == processor.identity.rid:
+        return
+    
     # already have an edge established
     if processor.network.graph.get_edge_profile(
         source=kobj.rid,

koi_net/protocol/event.py

@@ -15,6 +15,9 @@ class Event(BaseModel):
     manifest: Manifest | None = None
     contents: dict | None = None
     
+    class Config:
+        exclude_none = True
+    
     def __repr__(self):
         return f"<Event '{self.rid}' event type: '{self.event_type}'>"
     

{koi_net-1.0.0b17.dist-info → koi_net-1.0.0b19.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: koi-net
-Version: 1.0.0b17
+Version: 1.0.0b19
 Summary: Implementation of KOI-net protocol in Python
 Project-URL: Homepage, https://github.com/BlockScience/koi-net/
 Author-email: Luke Miller <luke@block.science>
@@ -150,36 +150,56 @@ Your first decision will be whether to setup a partial or full node:
 - Partial nodes only need to indicate their type, and optionally the RID types of events they provide.
 - Full nodes need to indicate their type, the base URL for their KOI-net API, and optionally the RID types of events and state they provide.
 
+Nodes are configured using the provided `NodeConfig` class. Defaults can be set as shown below, and will automatically load from and save to YAML files. See the `koi_net.config` module for more info.
+
 ### Partial Node
 ```python
 from koi_net import NodeInterface
 from koi_net.protocol.node import NodeProfile, NodeProvides, NodeType
-
-node = NodeInterface(
-    name="mypartialnode",
-    profile=NodeProfile(
-        node_type=NodeType.PARTIAL,
-        provides=NodeProvides(
-            event=[]
+from koi_net.config import NodeConfig, KoiNetConfig
+
+class CoordinatorNodeConfig(NodeConfig):
+    koi_net: KoiNetConfig | None = Field(default_factory = lambda:
+        KoiNetConfig(
+            node_name="coordinator",
+            node_profile=NodeProfile(
+                node_type=NodeType.FULL
+            ),
+            cache_directory_path=".basic_partial_rid_cache",
+            event_queues_path="basic_partial_event_queues.json",
+            first_contact="http://127.0.0.1:8000/koi-net"
         )
     )
+
+
+node = NodeInterface(
+    config=CoordinatorNodeConfig.load_from_yaml("basical_partial_config.yaml")
 )
 ```
 ### Full Node
 ```python
 from koi_net import NodeInterface
 from koi_net.protocol.node import NodeProfile, NodeProvides, NodeType
+from koi_net.config import NodeConfig, KoiNetConfig
+
+class CoordinatorNodeConfig(NodeConfig):
+    koi_net: KoiNetConfig | None = Field(default_factory = lambda:
+        KoiNetConfig(
+            node_name="coordinator",
+            node_profile=NodeProfile(
+                node_type=NodeType.FULL,
+                provides=NodeProvides(
+                    event=[KoiNetNode, KoiNetEdge],
+                    state=[KoiNetNode, KoiNetEdge]
+                )
+            ),
+            cache_directory_path=".coordinator_rid_cache",
+            event_queues_path="coordinator_event_queues.json"
+        )
+    )
 
 node = NodeInterface(
-    name="myfullnode",
-    profile=NodeProfile(
-        base_url="http://127.0.0.1:8000",
-        node_type=NodeType.FULL,
-        provides=NodeProvides(
-            event=[],
-            state=[]
-        )
-    ),
+    config=CoordinatorNodeConfig.load_from_yaml("coordinator_config.yaml"),
     use_kobj_processor_thread=True
 )
 ```
@@ -402,6 +422,7 @@ The default configuration provides four default handlers which will take precede
 ```python
 from koi_net import NodeInterface
 from koi_net.protocol.node import NodeProfile, NodeProvides, NodeType
+from koi_net.config import NodeConfig
 from koi_net.processor.default_handlers import (
     basic_rid_handler,
     basic_manifest_handler,
@@ -410,13 +431,7 @@ from koi_net.processor.default_handlers import (
 )
 
 node = NodeInterface(
-    name="mypartialnode",
-    profile=NodeProfile(
-        node_type=NodeType.PARTIAL,
-        provides=NodeProvides(
-            event=[]
-        )
-    ),
+    config=NodeConfig.load_from_yaml(),
     handlers=[
         basic_rid_handler,
         basic_manifest_handler,
@@ -437,23 +452,21 @@ This section provides high level explanations of the Python implementation. More
 The node class mostly acts as a container for other classes with more specialized behavior, with special functions that should be called to start up and shut down a node. We'll take a look at each of these components in turn, but here is the class stub:
 ```python
 class NodeInterface:
+    config: ConfigType
     cache: Cache
     identity: NodeIdentity
     network: NetworkInterface
     processor: ProcessorInterface
-    first_contact: str
+    
     use_kobj_processor_thread: bool
-
+    
     def __init__(
         self, 
-        name: str,
-        profile: NodeProfile,
-        identity_file_path: str = "identity.json",
-        event_queues_file_path: str = "event_queues.json",
-        cache_directory_path: str = "rid_cache",
+        config: ConfigType,
         use_kobj_processor_thread: bool = False,
-        first_contact: str | None = None,
+        
         handlers: list[KnowledgeHandler] | None = None,
+        
         cache: Cache | None = None,
         network: NetworkInterface | None = None,
         processor: ProcessorInterface | None = None
@@ -462,7 +475,58 @@ class NodeInterface:
     def start(self): ...
     def stop(self): ...
 ```
-As you can see, only a name and profile are required. The other fields allow for additional customization if needed.
+As you can see, only a node config is required, all other fields are optional.
+
+## Node Config
+
+The node config class is a mix of configuration groups providing basic shared behavior across nodes through a standard interface. The class is implemented as Pydantic model, but provides functions to load from and save to a YAML file, the expected format within a node repo.
+
+```python
+class ServerConfig(BaseModel):
+    host: str | None = "127.0.0.1"
+    port: int | None = 8000
+    path: str | None = "/koi-net"
+    
+    @property
+    def url(self) -> str: ...
+
+class KoiNetConfig(BaseModel):
+    node_name: str
+    node_rid: KoiNetNode | None = None
+    node_profile: NodeProfile
+    
+    cache_directory_path: str | None = ".rid_cache"
+    event_queues_path: str | None = "event_queues.json"
+
+    first_contact: str | None = None
+
+class EnvConfig(BaseModel):
+    ...
+
+class NodeConfig(BaseModel):
+    server: ServerConfig | None = Field(default_factory=ServerConfig)
+    koi_net: KoiNetConfig
+
+    @classmethod
+    def load_from_yaml(
+        cls, 
+        file_path: str = "config.yaml", 
+        generate_missing: bool = True
+    ): ...
+    
+    def save_to_yaml(self): ...
+```
+
+Nodes are expected to create new node config classes inheriting from `NodeConfig`. You may want to set a default KoiNetConfig (see examples) to allow for a default config to be generated if not provided by the user. Environment variables can be handled by inheriting from the `EnvConfig` class and adding new string fields. The value of this field should be equivalent to the environment variable name, for example:
+
+```python
+class SlackEnvConfig(EnvConfig):
+    slack_bot_token: str | None = "SLACK_BOT_TOKEN"
+    slack_signing_secret: str | None = "SLACK_SIGNING_SECRET"
+    slack_app_token: str | None = "SLACK_APP_TOKEN"
+```
+
+This special config class will automatically load in the variables from the current environment, or local `.env` file. Beyond these base config classes, you are free to add your own config groups. See `config.py` in the [koi-net-slack-sensor-node](https://github.com/BlockScience/koi-net-slack-sensor-node/blob/main/slack_sensor_node/config.py) repo for a more complete example.
 
 ## Node Identity
 The `NodeIdentity` class provides easy access to a node's own RID, profile, and bundle. It provides access to the following properties after initialization, accessed with `node.identity`.
@@ -472,7 +536,7 @@ class NodeIdentity:
     profile: NodeProfile
     bundle: Bundle
 ```
-This it what is initialized from the required `name` and `profile` fields in the `NodeInterface` constructor. Node RIDs take the form of `orn:koi-net.node:<name>+<uuid>`, and are generated on first use to the identity JSON file along with a the node profile.
+This it what is initialized from the required `name` and `profile` fields in the `NodeConfig` class. Node RIDs take the form of `orn:koi-net.node:<name>+<uuid>`, and are generated on first use to the identity JSON file along with a the node profile.
 
 ## Network Interface
 The `NetworkInterface` class provides access to high level network actions, and contains several other network related classes. It is accessed with `node.network`.

{koi_net-1.0.0b17.dist-info → koi_net-1.0.0b19.dist-info}/RECORD

@@ -1,5 +1,5 @@
 koi_net/__init__.py,sha256=b0Ze0pZmJAuygpWUFHM6Kvqo3DkU_uzmkptv1EpAArw,31
-koi_net/config.py,sha256=35RNSOcWxnJzasPAkYabFWcKyDR-2kM1NTrq_fYOkm0,3153
+koi_net/config.py,sha256=TIKb1kFTcEysqwdHp6yCNpcXeS84dlprcb-f0z2jF0Y,3160
 koi_net/core.py,sha256=IO8kqiNMYVeuNzilq7eHBA7IulsxRjrCbWnIAx6_abA,4406
 koi_net/identity.py,sha256=muc5vuQ8zUOebhwAB3-ql6W2pgQETiYXXQAFBv8bLyg,1288
 koi_net/network/__init__.py,sha256=r_RN-q_mDYC-2RAkN-lJoMUX76TXyfEUc_MVKW87z0g,39
@@ -8,7 +8,7 @@ koi_net/network/interface.py,sha256=icpl0rzpC5yV86BQBAbjAjK7AWhgCFoyFLm_Fjf1mCI,
 koi_net/network/request_handler.py,sha256=66gjX2x4UnBWZYwKLjp_3WkhL-ekhR3VAyfGviHTcUs,4790
 koi_net/network/response_handler.py,sha256=CAwici2Etj9ESndERXdtYkMlc4gWHz_xc7jHgY2Qjcg,1830
 koi_net/processor/__init__.py,sha256=x4fAY0hvQEDcpfdTB3POIzxBQjYAtn0qQazPo1Xm0m4,41
-koi_net/processor/default_handlers.py,sha256=f8Yl21lLGMa_oW51bf8sBuunfP9_rmiSu32T-rZ4kUY,8542
+koi_net/processor/default_handlers.py,sha256=dP64lEJ64BJ7H8PhFK-GZI1pv51tVVINV4jAgcOtOhc,8669
 koi_net/processor/handler.py,sha256=7X6M6PP8m6-xdtsP1y4QO83g_MN5VSszNNikprITK80,2523
 koi_net/processor/interface.py,sha256=Kyw4SQos_1WdcPJJe-j2w4xDIfwtmpF4mfGlkRVRqUI,12876
 koi_net/processor/knowledge_object.py,sha256=RCgzkILsWm1Jw_NkSu4jTRYA9Ugga6mJ4jqKWwketQs,4090
@@ -16,10 +16,10 @@ koi_net/protocol/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,
 koi_net/protocol/api_models.py,sha256=DYDKCRD2Uja633bBAyTsaxyb1oF9pX9yQ9NpNAbkczo,1070
 koi_net/protocol/consts.py,sha256=bisbVEojPIHlLhkLafBzfIhH25TjNfvTORF1g6YXzIM,243
 koi_net/protocol/edge.py,sha256=CcmvIY4P1HEBdKNJ4wFRDmwYMRMss24Besmbi7ZRFxQ,427
-koi_net/protocol/event.py,sha256=HxzLN-iCXPyr2YzrswMIkgZYeUdFbBpa5v98dAB06lQ,1328
+koi_net/protocol/event.py,sha256=eGgihEj1gliLoQRk8pVB2q_was0AGo-PbT3Hqnpn3oU,1379
 koi_net/protocol/helpers.py,sha256=8ZkQrjb_G0QEaMIKe9wkFOBonl1bkmemx_pwKMwIiLg,695
 koi_net/protocol/node.py,sha256=2HhCh3LdBLlY2Z_kXNmKHzpVLKbP_ODob3HjHayFQtM,375
-koi_net-1.0.0b17.dist-info/METADATA,sha256=5kfC3M0D9boL2YDIsIRy1T3HRDZkEPJhl2KsPgNeihI,34203
-koi_net-1.0.0b17.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-koi_net-1.0.0b17.dist-info/licenses/LICENSE,sha256=03mgCL5qth2aD9C3F3qNVs4sFJSpK9kjtYCyOwdSp7s,1069
-koi_net-1.0.0b17.dist-info/RECORD,,
+koi_net-1.0.0b19.dist-info/METADATA,sha256=uVzxDiRiHRncwfjotk7j_frmm_ka6PEpI-kcA278HoE,37107
+koi_net-1.0.0b19.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+koi_net-1.0.0b19.dist-info/licenses/LICENSE,sha256=03mgCL5qth2aD9C3F3qNVs4sFJSpK9kjtYCyOwdSp7s,1069
+koi_net-1.0.0b19.dist-info/RECORD,,