neuronum 4.0.1__py3-none-any.whl → 5.1.0__py3-none-any.whl

cli/main.py

@@ -249,10 +249,11 @@ def delete_cell():
 @click.command()
 @click.option('--sync', multiple=True, default=None, help="Optional stream IDs for sync.")
 @click.option('--stream', multiple=True, default=None, help="Optional stream ID for stream.")
-def init_node(sync, stream):
-    asyncio.run(async_init_node(sync, stream))
+@click.option('--app', is_flag=True, help="Generate a Node with app template")
+def init_node(sync, stream, app):
+    asyncio.run(async_init_node(sync, stream, app))
 
-async def async_init_node(sync, stream):
+async def async_init_node(sync, stream, app):
     credentials_folder_path = Path.home() / ".neuronum"
     env_path = credentials_folder_path / ".env"
 
@@ -319,13 +320,35 @@ async def async_init_node(sync, stream):
     await asyncio.to_thread(gitignore_path.write_text, ".env\n")
 
     nodemd_path = project_path / "NODE.md"
-    await asyncio.to_thread(nodemd_path.write_text, """### Getting started template: Neuronum NODE.md 
-### Use this .md file to add instructions on how to interact with your Node
+    await asyncio.to_thread(nodemd_path.write_text, """### NODE.md: How to interact with this Node
 
 ```json
 {
-    "Use Case": "Getting started Node streaming: Hello, Neuronum!",
-    "Requirements": [
+    "info": {
+        "use_case": "This Node...",
+        "github": "https://github.com/user"
+    },
+    "gateways": [
+        {
+            "type": "stream",
+            "id": "id::stx",
+            "link": "https://neuronum.net/stream/id::stx"
+        },
+        {
+            "type": "transmitter",
+            "id": "id::tx",
+            "link": "https://neuronum.net/tx/id::tx", 
+        }
+        {
+            "type": "circuit",
+            "id": "id::ctx",
+            "link": "https://neuronum.net/circuit/id::ctx", 
+        }
+    ],
+    "initialization": {
+        "command": "neuronum init-node --sync id::stx"
+    },
+    "requirements": [
         {
             "name": "Python",
             "version": ">= 3.8",
@@ -333,12 +356,10 @@ async def async_init_node(sync, stream):
         },
         {
             "name": "neuronum",
-            "version": ">= 4.0.0",
+            "version": ">= 5.1.0",
             "link": "https://pypi.org/project/neuronum/"
         }
-    ],
-    "Installation": "pip install neuronum",
-    "Initialization": "neuronum init-node"
+    ]
 }
 ```"""
 )
@@ -418,7 +439,7 @@ async def main():
 asyncio.run(main())
 """)
     
-    if not sync and not stream:
+    if not sync and not stream and not app:
         sync_path = project_path / f"sync_{stx.replace('::stx', '')}.py"
         sync_path.write_text(f"""\
 import asyncio
@@ -476,6 +497,56 @@ async def main():
         }}
         await cell.stream(label, data)
 
+asyncio.run(main())
+""")
+        
+    if app:
+        app_path = project_path / "app.py"
+        app_path.write_text(f"""\
+import asyncio
+import neuronum
+import os
+from dotenv import load_dotenv
+
+load_dotenv()
+host = os.getenv("HOST")
+password = os.getenv("PASSWORD")
+network = os.getenv("NETWORK")
+synapse = os.getenv("SYNAPSE")
+
+cell = neuronum.Cell(
+    host=host,
+    password=password,
+    network=network,
+    synapse=synapse
+)
+
+async def main():
+    STX = "id::stx"                        
+    async for operation in cell.sync(STX):       
+        txID = operation.get("txID")
+                            
+        if txID == "id::tx":
+            client = operation.get("operator")             
+            data = {{
+                "response": "TX activated!"
+            }}
+            await cell.tx_response(txID, client, data)
+
+        if txID == "id::tx":
+            client = operation.get("operator")
+            data = {{
+                "response": "TX activated!"
+            }}
+            await cell.tx_response(txID, client, data)
+
+        if txID == "id::tx":
+            client = operation.get("operator")
+            data = {{
+                "response": "TX activated!"
+            }}
+            await cell.tx_response(txID, client, data)
+
 asyncio.run(main())
 """)
         
@@ -488,7 +559,7 @@ def start_node(d):
     click.echo("Starting Node...")
 
     project_path = Path.cwd()
-    script_files = glob.glob("sync_*.py") + glob.glob("stream_*.py")
+    script_files = glob.glob("sync_*.py") + glob.glob("stream_*.py") + glob.glob("app.py")
 
     processes = []
     system_name = platform.system()

neuronum/neuronum.py

@@ -13,6 +13,7 @@ class Cell:
         self.synapse = synapse
         self.queue = asyncio.Queue()
 
+
     def to_dict(self) -> dict:
         return {
             "host": self.host,
@@ -20,8 +21,98 @@ class Cell:
             "synapse": self.synapse
         }
 
+
     def __repr__(self) -> str:
         return f"Cell(host={self.host}, password={self.password}, network={self.network}, synapse={self.synapse})"
+    
+
+    async def stream(self, label: str, data: dict, stx: Optional[str] = None, retry_delay: int = 3):
+        context = ssl.create_default_context()
+        context.check_hostname = True
+        context.verify_mode = ssl.CERT_REQUIRED
+
+        while True:
+            try:
+                reader, writer = await asyncio.open_connection(self.network, 55555, ssl=context, server_hostname=self.network)
+
+                credentials = f"{self.host}\n{self.password}\n{self.synapse}\n{stx}\n"
+                writer.write(credentials.encode("utf-8"))
+                await writer.drain()
+
+                response = await reader.read(1024)
+                response_text = response.decode("utf-8").strip()
+
+                if "Authentication successful" not in response_text:
+                    print("Authentication failed, retrying...")
+                    writer.close()
+                    await writer.wait_closed()
+                    await asyncio.sleep(retry_delay)
+                    continue
+
+                stream_payload = {
+                    "label": label,
+                    "data": data,
+                }
+
+                writer.write(json.dumps(stream_payload).encode("utf-8"))
+                await writer.drain()
+
+                response = await reader.read(1024)
+                response_text = response.decode("utf-8").strip()
+
+                if response_text == "Sent":
+                    print(f"Success: {response_text} - {stream_payload}")
+                    break
+                else:
+                    print(f"Error sending: {stream_payload}")
+
+            except (ssl.SSLError, ConnectionError) as e:
+                print(f"Connection error: {e}, retrying...")
+                await asyncio.sleep(retry_delay)
+
+            except Exception as e:
+                print(f"Unexpected error: {e}, retrying...")
+                await asyncio.sleep(retry_delay)
+
+            finally:
+                if 'writer' in locals():
+                    writer.close()
+                    await writer.wait_closed()
+
+
+    async def sync(self, stx: Optional[str] = None) -> AsyncGenerator[str, None]:
+        full_url = f"wss://{self.network}/sync/{stx}"
+        
+        auth_payload = {
+            "host": self.host,
+            "password": self.password,
+            "synapse": self.synapse,
+        }
+
+        try:
+            async with websockets.connect(full_url) as ws:
+                await ws.send(json.dumps(auth_payload))
+                print("Listening to Stream...")
+
+                try:
+                    while True:
+                        try:
+                            raw_operation = await ws.recv()
+                            operation = json.loads(raw_operation)
+                            yield operation
+
+                        except asyncio.TimeoutError:
+                            print("No initial data received. Continuing to listen...")
+                            continue
+
+                except asyncio.CancelledError:
+                    print("Connection closed.")
+
+        except websockets.exceptions.WebSocketException as e:
+            print(f"WebSocket error occurred: {e}")
+
+        except Exception as e:
+            print(f"An unexpected error occurred: {e}")
            
 
     async def create_tx(self, descr: str, key_values: dict, stx: str, label: str, partners: list):
@@ -73,7 +164,6 @@ class Cell:
 
     async def activate_tx(self, txID: str, data: dict):
         url = f"https://{self.network}/api/activate_tx/{txID}"
-
         TX = {
             "data": data,
             "cell": self.to_dict()
@@ -82,10 +172,40 @@ class Cell:
         async with aiohttp.ClientSession() as session:
             try:
                 async with session.post(url, json=TX) as response:
-                    response.raise_for_status()
                     response.raise_for_status()
                     data = await response.json()
-                    print(data["message"])
+                    if data["success"] == "activated":
+                        async for operation in self.sync():
+                            label = operation.get("label")
+                            if label == "tx_response":
+                                operation_txID = operation.get("txID")
+                                if operation_txID == txID:
+                                    return operation.get("data")
+                    else:
+                        print(data["success"], data["message"])
+
+            except aiohttp.ClientError as e:
+                print(f"Error sending request: {e}")
+            except Exception as e:
+                print(f"Unexpected error: {e}")
+
+
+    async def tx_response(self, txID: str, client: str, data: dict):
+        url = f"https://{self.network}/api/tx_response/{txID}"
+
+        tx_response = {
+            "client": client,
+            "data": data,
+            "cell": self.to_dict()
+        }
+
+        async with aiohttp.ClientSession() as session:
+            try:
+                for _ in range(2):
+                    async with session.post(url, json=tx_response) as response:
+                        response.raise_for_status()
+                        data = await response.json()
+                print(data["message"])
 
             except aiohttp.ClientError as e:
                 print(f"Error sending request: {e}")
@@ -368,80 +488,4 @@ class Cell:
                 print(f"Unexpected error: {e}")
 
 
-    async def stream(self, label: str, data: dict, stx: Optional[str] = None):
-        context = ssl.create_default_context()
-        context.check_hostname = True
-        context.verify_mode = ssl.CERT_REQUIRED
-
-        try:
-            reader, writer = await asyncio.open_connection(self.network, 55555, ssl=context, server_hostname=self.network)
-
-            credentials = f"{self.host}\n{self.password}\n{self.synapse}\n{stx}\n"
-            writer.write(credentials.encode("utf-8"))
-            await writer.drain()
-
-            response = await reader.read(1024)
-            response_text = response.decode("utf-8")
-
-            if "Authentication successful" not in response_text:
-                print("Authentication failed")
-                writer.close()
-                await writer.wait_closed()
-                return
-
-            stream_payload = {
-                "label": label,
-                "data": data,
-            }
-
-            writer.write(json.dumps(stream_payload).encode("utf-8"))
-            await writer.drain()
-            print(f"Sent: {stream_payload}")
-
-        except ssl.SSLError as e:
-            print(f"SSL error occurred: {e}")
-
-        except Exception as e:
-            print(f"An unexpected error occurred: {e}")
-
-        finally:
-            writer.close()
-            await writer.wait_closed()
-
-
-    async def sync(self, stx: Optional[str] = None) -> AsyncGenerator[str, None]:
-        full_url = f"wss://{self.network}/sync/{stx}"
-        
-        auth_payload = {
-            "host": self.host,
-            "password": self.password,
-            "synapse": self.synapse,
-        }
-
-        try:
-            async with websockets.connect(full_url) as ws:
-                await ws.send(json.dumps(auth_payload))
-                print("Listening to Stream...")
-
-                try:
-                    while True:
-                        try:
-                            raw_operation = await ws.recv()
-                            operation = json.loads(raw_operation)
-                            yield operation
-
-                        except asyncio.TimeoutError:
-                            print("No initial data received. Continuing to listen...")
-                            continue
-
-                except asyncio.CancelledError:
-                    print("Connection closed.")
-
-        except websockets.exceptions.WebSocketException as e:
-            print(f"WebSocket error occurred: {e}")
-
-        except Exception as e:
-            print(f"An unexpected error occurred: {e}")
-
-
 __all__ = ['Cell']

{neuronum-4.0.1.dist-info → neuronum-5.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: neuronum
-Version: 4.0.1
+Version: 5.1.0
 Summary: Official client library to interact with the Neuronum Network
 Home-page: https://neuronum.net
 Author: Neuronum Cybernetics
@@ -35,23 +35,23 @@ Dynamic: summary
 [![Website](https://img.shields.io/badge/Website-Neuronum-blue)](https://neuronum.net) [![Documentation](https://img.shields.io/badge/Docs-Read%20now-green)](https://github.com/neuronumcybernetics/neuronum)
 
 
-### **Getting Started Goals**
+## **Getting Started Goals**
 - Learn about Neuronum
 - Connect to Neuronum
 - Build on Neuronum
 
 
 ### **About Neuronum**
-Neuronum is a framework to build serverless data gateways automating the processing and distribution of data transmission, storage, and streaming.
+Neuronum is a framework to build serverless connected app & data gateways automating the processing and distribution of data transmission, storage, and streaming.
 
 
-### **Neuronum Attributes**
+### **Features**
 **Cell & Nodes**
 - Cell: Account to connect and interact with Neuronum
-- Nodes: Soft- and Hardware components hosting data gateways
+- Nodes: Soft- and Hardware components hosting gateways
 
-**Data Gateways**
-- Transmitters (TX): Automate data transfer in standardized formats
+**Gateways**
+- Transmitters (TX): Securely transmit and receive data packages
 - Circuits (CTX): Store data in cloud-based key-value-label databases
 - Streams (STX): Stream, synchronize, and control data in real time
 
@@ -75,6 +75,12 @@ Create Cell:
 neuronum create-cell                    # create Cell / Cell type / Cell network 
 ```
 
+or
+
+Connect Cell:
+```sh
+neuronum connect-cell                   # connect Cell
+```
 
 View connected Cell:
 ```sh
@@ -86,11 +92,25 @@ neuronum view-cell                      # view Cell / output = Connected Cell: '
 
 
 ### **Build on Neuronum**
+**Node Examples:**  
+Visit: https://github.com/neuronumcybernetics/neuronum/tree/main/how_tos/nodes
+
 Initialize Node (default template):
 ```sh
 neuronum init-node                      # initialize a Node with default template
 ```
 
+Start Node:
+```sh
+neuronum start-node                     # start Node
+```
 
-**Node Examples:**  
-Visit: https://github.com/neuronumcybernetics/neuronum/tree/main/how_tos/nodes
+Stop Node:
+```sh
+neuronum stop-node                      # stop Node
+```
+
+Connect Node to Neuronum:
+```sh
+neuronum connect-node                   # connect Node
+```

neuronum-5.1.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cli/main.py,sha256=tklC9GhJCB-zR26djn9D3ke6P6SGR2Jq66mG1a1Si3g,26848
+neuronum/__init__.py,sha256=Drsm263_w3_VWgl1YsKLUr8WwVodqV3TSjqpxLjyq_M,46
+neuronum/neuronum.py,sha256=qzxc9csSEnGX8wRC_14vzjJPQsCTC8wswhXno1Ih_Xw,17166
+neuronum-5.1.0.dist-info/licenses/LICENSE,sha256=UiZjNHiCyRP6WoZfbYQh9cv4JW96wIofKXmzBJrYSUk,1125
+neuronum-5.1.0.dist-info/METADATA,sha256=zgR264a9Ukp5wE7tIfNkbqCOpGB_vdA3vWqvJSnYZZc,3060
+neuronum-5.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+neuronum-5.1.0.dist-info/entry_points.txt,sha256=XKYBcRNxGeJpZZkDPsa8HA_RaJ7Km_R_JaUq5T9Nk2U,42
+neuronum-5.1.0.dist-info/top_level.txt,sha256=ru8Fr84cHm6oHr_DcJ8-uaq3RTiuCRFIr6AC8V0zPu4,13
+neuronum-5.1.0.dist-info/RECORD,,

neuronum-4.0.1.dist-info/RECORD

@@ -1,10 +0,0 @@
-cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-cli/main.py,sha256=g7Y-W1G7C1firXHsEnBFyqa52nSk6GVzcax_6up0Ezg,24991
-neuronum/__init__.py,sha256=Drsm263_w3_VWgl1YsKLUr8WwVodqV3TSjqpxLjyq_M,46
-neuronum/neuronum.py,sha256=botQ0FJIf5e00MqfUeIcD6aAchys9vSsQ3ymj8YzGMc,15223
-neuronum-4.0.1.dist-info/licenses/LICENSE,sha256=UiZjNHiCyRP6WoZfbYQh9cv4JW96wIofKXmzBJrYSUk,1125
-neuronum-4.0.1.dist-info/METADATA,sha256=SVe3ktDGVnjOpjl4PXi0QtIFOgW84Mr0TzfDJpivwsY,2725
-neuronum-4.0.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-neuronum-4.0.1.dist-info/entry_points.txt,sha256=XKYBcRNxGeJpZZkDPsa8HA_RaJ7Km_R_JaUq5T9Nk2U,42
-neuronum-4.0.1.dist-info/top_level.txt,sha256=ru8Fr84cHm6oHr_DcJ8-uaq3RTiuCRFIr6AC8V0zPu4,13
-neuronum-4.0.1.dist-info/RECORD,,