neuronum 5.0.1__tar.gz → 5.1.0__tar.gz

{neuronum-5.0.1/neuronum.egg-info → neuronum-5.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: neuronum
-Version: 5.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
@@ -103,3 +109,8 @@ Stop Node:
 ```sh
 neuronum stop-node                      # stop Node
 ```
+
+Connect Node to Neuronum:
+```sh
+neuronum connect-node                   # connect Node
+```

{neuronum-5.0.1 → neuronum-5.1.0}/README.md

@@ -3,23 +3,23 @@
 [![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
 
@@ -43,6 +43,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
@@ -70,4 +76,9 @@ neuronum start-node                     # start Node
 Stop Node:
 ```sh
 neuronum stop-node                      # stop Node
+```
+
+Connect Node to Neuronum:
+```sh
+neuronum connect-node                   # connect Node
 ```

{neuronum-5.0.1 → neuronum-5.1.0}/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-5.0.1 → neuronum-5.1.0/neuronum.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: neuronum
-Version: 5.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
@@ -103,3 +109,8 @@ Stop Node:
 ```sh
 neuronum stop-node                      # stop Node
 ```
+
+Connect Node to Neuronum:
+```sh
+neuronum connect-node                   # connect Node
+```

{neuronum-5.0.1 → neuronum-5.1.0}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 
 setup(
     name='neuronum',
-    version='5.0.1',
+    version='5.1.0',
     author='Neuronum Cybernetics',
     author_email='welcome@neuronum.net',
     description='Official client library to interact with the Neuronum Network',