neuronum 1.6.0__py3-none-any.whl → 1.7.0__py3-none-any.whl

cli/main.py

@@ -13,8 +13,238 @@ def cli():
 
 
 @click.command()
-def init_node():
-    click.echo("Initialize Node")
+def create_cell():
+    cell_type = questionary.select(
+        "Choose Cell type:",
+        choices=["business", "community"]
+    ).ask()
+
+    network = questionary.select(
+        "Choose Network:",
+        choices=["neuronum.net"]
+    ).ask()
+
+    if cell_type == "business":
+        click.echo("Visit https://neuronum.net/createcell to create your Neuronum Business Cell")
+
+    if cell_type == "community":
+
+        email = click.prompt("Enter email")
+        password = click.prompt("Enter password", hide_input=True)
+        repeat_password = click.prompt("Repeat password", hide_input=True)
+
+        if password != repeat_password:
+            click.echo("Passwords do not match!")
+            return
+
+        url = f"https://{network}/api/create_cell/{cell_type}"
+
+        create_cell = {"email": email, "password": password}
+
+        try:
+            response = requests.post(url, json=create_cell)
+            response.raise_for_status()
+            status = response.json()["status"]
+
+        except requests.exceptions.RequestException as e:
+            click.echo(f"Error sending request: {e}")
+            return
+        
+        if status == True:
+            host = response.json()["host"]
+            cellkey = click.prompt(f"Please verify your email address with the Cell Key send to {email}")
+
+            url = f"https://{network}/api/verify_email"
+
+            verify_email = {"host": host, "email": email, "cellkey": cellkey}
+
+            try:
+                response = requests.post(url, json=verify_email)
+                response.raise_for_status()
+                status = response.json()["status"]
+
+            except requests.exceptions.RequestException as e:
+                click.echo(f"Error sending request: {e}")
+                return
+        
+            if status == True:
+                synapse = response.json()["synapse"]
+                credentials_folder_path = Path.home() / ".neuronum"
+                credentials_folder_path.mkdir(parents=True, exist_ok=True)
+
+                env_path = credentials_folder_path / ".env"
+                env_path.write_text(f"HOST={host}\nPASSWORD={password}\nNETWORK={network}\nSYNAPSE={synapse}\n")
+
+                click.echo(f"Welcome to Neuronum! Community Cell '{host}' created and connected!")
+
+        if status == False:
+            click.echo(f"Error:'{email}' already assigned!")
+
+
+
+@click.command()
+def connect_cell():
+    email = click.prompt("Enter your Email")
+    password = click.prompt("Enter password", hide_input=True)
+
+    network = questionary.select(
+        "Choose Network:",
+        choices=["neuronum.net"]
+    ).ask()
+
+    url = f"https://{network}/api/connect_cell"
+    payload = {"email": email, "password": password}
+
+    try:
+        response = requests.post(url, json=payload)
+        response.raise_for_status()
+        status = response.json()["status"]
+        host = response.json()["host"]
+    except requests.exceptions.RequestException as e:
+        click.echo(f"Error connecting: {e}")
+        return
+    
+    if status == True:
+        cellkey = click.prompt(f"Please verify your email address with the Cell Key send to {email}")
+        url = f"https://{network}/api/verify_email"
+        verify_email = {"host": host, "email": email, "cellkey": cellkey}
+
+        try:
+            response = requests.post(url, json=verify_email)
+            response.raise_for_status()
+            status = response.json()["status"]
+            synapse = response.json()["synapse"]
+
+        except requests.exceptions.RequestException as e:
+            click.echo(f"Error sending request: {e}")
+            return
+
+        if status == True:
+            credentials_folder_path = Path.home() / ".neuronum"
+            credentials_folder_path.mkdir(parents=True, exist_ok=True)
+
+            env_path = credentials_folder_path / f".env"
+            env_path.write_text(f"HOST={host}\nPASSWORD={password}\nNETWORK={network}\nSYNAPSE={synapse}\n")
+
+            click.echo(f"Cell '{host}' connected!")
+    else:
+        click.echo(f"Connection failed!")
+
+
+@click.command()
+def view_cell():
+    credentials_folder_path = Path.home() / ".neuronum"
+    env_path = credentials_folder_path / ".env"
+
+    env_data = {}
+
+    try:
+        with open(env_path, "r") as f:
+            for line in f:
+                key, value = line.strip().split("=")
+                env_data[key] = value
+
+        host = env_data.get("HOST", "")
+
+    except FileNotFoundError:
+        click.echo("Error: No credentials found. Please connect to a cell first.")
+        return
+    except Exception as e:
+        click.echo(f"Error reading .env file: {e}")
+        return
+
+    if host:
+        click.echo(f"Connected Cell: '{host}'")
+    else:
+        click.echo("No active cell connection found.")
+
+
+@click.command()
+def disconnect_cell():
+    credentials_folder_path = Path.home() / ".neuronum"
+    env_path = credentials_folder_path / ".env"
+
+    env_data = {}
+
+    try:
+        with open(env_path, "r") as f:
+            for line in f:
+                key, value = line.strip().split("=")
+                env_data[key] = value
+
+        host = env_data.get("HOST", "")
+
+    except FileNotFoundError:
+        click.echo("Error: .env with credentials not found")
+        return
+    except Exception as e:
+        click.echo(f"Error reading .env file: {e}")
+        return
+
+    if env_path.exists():
+        if click.confirm(f"Are you sure you want to disconnect Cell '{host}'?", default=True):
+            os.remove(env_path)
+            click.echo(f"'{host}' disconnected!")
+        else:
+            click.echo("Disconnect canceled.")
+    else:
+        click.echo(f"No Neuronum Cell connected!")
+
+
+@click.command()
+def delete_cell():
+    credentials_folder_path = Path.home() / ".neuronum"
+    env_path = credentials_folder_path / ".env"
+
+    env_data = {}
+
+    try:
+        with open(env_path, "r") as f:
+            for line in f:
+                key, value = line.strip().split("=")
+                env_data[key] = value
+
+        host = env_data.get("HOST", "")
+        password = env_data.get("PASSWORD", "")
+        network = env_data.get("NETWORK", "")
+        synapse = env_data.get("SYNAPSE", "")
+
+    except FileNotFoundError:
+        click.echo("Error: No cell connected. Connect Cell first to delete")
+        return
+    except Exception as e:
+        click.echo(f"Error reading .env file: {e}")
+        return
+
+    confirm = click.confirm(f" Are you sure you want to delete '{host}'?", default=True)
+    if not confirm:
+        click.echo("Deletion canceled.")
+        return
+
+    url = f"https://{network}/api/delete_cell"
+    payload = {"host": host, "password": password, "synapse": synapse}
+
+    try:
+        response = requests.delete(url, json=payload)
+        response.raise_for_status()
+        status = response.json()["status"]
+    except requests.exceptions.RequestException as e:
+        click.echo(f"Error deleting cell: {e}")
+        return
+    
+    if status == True:
+        env_path = credentials_folder_path / f"{host}.env"
+        if env_path.exists():
+            os.remove(env_path)
+            click.echo("Credentials deleted successfully!")
+        click.echo(f"Neuronum Cell '{host}' has been deleted!")
+    else: 
+        click.echo(f"Neuronum Cell '{host}' deletion failed!")
+ 
+
+@click.command()
+@click.option('--sync', default=None, help="Optional stream ID to generate the sync template.")
+def init_node(sync):
 
     node_type = questionary.select(
         "Choose Node type:",
@@ -22,10 +252,31 @@ def init_node():
     ).ask()
 
     descr = click.prompt("Node description (max. 25 characters)")
-    host = click.prompt("Enter your cell host")
-    password = click.prompt("Enter your password", hide_input=True)
-    network = click.prompt("Enter your network")
-    synapse = click.prompt("Enter your synapse", hide_input=True)
+
+    stream = sync if sync else "n9gW3LxQcecI::stx"
+
+    credentials_folder_path = Path.home() / ".neuronum"
+    env_path = credentials_folder_path / ".env"
+
+    env_data = {}
+
+    try:
+        with open(env_path, "r") as f:
+            for line in f:
+                key, value = line.strip().split("=")
+                env_data[key] = value
+
+        host = env_data.get("HOST", "")
+        password = env_data.get("PASSWORD", "")
+        network = env_data.get("NETWORK", "")
+        synapse = env_data.get("SYNAPSE", "")
+
+    except FileNotFoundError:
+        click.echo("No cell connected. Connect your cell with command neuronum connect-cell")
+        return
+    except Exception as e:
+        click.echo(f"Error reading .env file: {e}")
+        return
 
     cell = neuronum.Cell(
     host=host,         
@@ -51,13 +302,16 @@ def init_node():
         click.echo(f"Error sending request: {e}")
         return
 
-    node_filename = "node"
+    node_filename = "node_" + nodeID.replace("::node", "")
     project_path = Path(node_filename)
     project_path.mkdir(exist_ok=True)
 
     env_path = project_path / ".env"
     env_path.write_text(f"NODE={nodeID}\nHOST={host}\nPASSWORD={password}\nNETWORK={network}\nSYNAPSE={synapse}\n")
 
+    gitignore_path = project_path / ".gitignore"
+    gitignore_path.write_text(f".env\n")
+
     tx_path = project_path / "transmitters.json"
     tx_path.write_text(json.dumps(tx, indent=4))
 
@@ -72,30 +326,29 @@ def init_node():
 
     nodemd_path = project_path / "NODE.md"
     nodemd_path.write_text("""\
-#some markdown                             
+## Use this NODE.md file to add instructions on how to interact with your node                        
 """)
         
     main_path = project_path / "main.py"
-    main_path.write_text("""\
+    main_path.write_text(f"""\
 import neuronum
 import os
 from dotenv import load_dotenv
 
 load_dotenv()
-host = os.getenv("HOST")    
+host = os.getenv("HOST")
 password = os.getenv("PASSWORD")
-network = os.getenv("NETWORK")                                                                                            
-synapse = os.getenv("SYNAPSE")                    
+network = os.getenv("NETWORK")
+synapse = os.getenv("SYNAPSE")
 
-#set cell connection
 cell = neuronum.Cell(
-host=host,
-password=password,
-network=network,
-synapse=synapse
+    host=host,
+    password=password,
+    network=network,
+    synapse=synapse
 )
 
-STX = "n9gW3LxQcecI::stx"
+STX = "{stream}"
 stream = cell.sync(STX)
 for operation in stream:
     label = operation.get("label")
@@ -104,7 +357,7 @@ for operation in stream:
     stxID = operation.get("stxID")
     operator = operation.get("operator")
     print(label, value, ts, stxID, operator)                              
-    """)
+""")
 
     click.echo(f"Neuronum Node '{nodeID}' initialized!")
 
@@ -125,20 +378,19 @@ def start_node():
     with open("node_pid.txt", "w") as f:
         f.write(str(process.pid))
 
-    click.echo("Neuronum Node started successfully!")
+    click.echo("Node started successfully!")
 
 
 @click.command()
 def stop_node():
-    """Stops the Neuronum node"""
-    click.echo("Stopping Neuronum Node...")
+    click.echo("Stopping Node...")
 
     try:
         with open("node_pid.txt", "r") as f:
             pid = int(f.read().strip())
         os.kill(pid, 9) 
         os.remove("node_pid.txt")
-        click.echo("Neuronum Node stopped successfully!")
+        click.echo("Node stopped successfully!")
     except FileNotFoundError:
         click.echo("Error: No active node process found.")
     except Exception as e:
@@ -147,10 +399,7 @@ def stop_node():
 
 @click.command()
 def register_node():
-    click.echo("Register Node")
-
     env_data = {}
-
     try:
         with open(".env", "r") as f:
             for line in f:
@@ -205,10 +454,7 @@ def register_node():
 
 @click.command()
 def update_node():
-    click.echo("Update Node")
-
     env_data = {}
-
     try:
         with open(".env", "r") as f:
             for line in f:
@@ -286,10 +532,7 @@ def update_node():
 
 @click.command()
 def delete_node():
-    click.echo("Delete Node")
-
     env_data = {}
-
     try:
         with open(".env", "r") as f:
             for line in f:
@@ -329,6 +572,11 @@ def delete_node():
     click.echo(f"Neuronum Node '{nodeID}' deleted!")
 
 
+cli.add_command(create_cell)
+cli.add_command(connect_cell)
+cli.add_command(view_cell)
+cli.add_command(disconnect_cell)
+cli.add_command(delete_cell)
 cli.add_command(init_node)
 cli.add_command(start_node)
 cli.add_command(stop_node)

neuronum/neuronum.py

@@ -256,23 +256,6 @@ class Cell:
         except Exception as e:
             print(f"Unexpected error: {e}")
 
-
-    def connect(self):
-            url = f"https://{self.network}/api/connect"
-
-            test = {
-                "cell": self.to_dict() 
-            }
-
-            try:
-                response = requests.post(url, json=test)
-                response.raise_for_status()
-                print(response.json()["connection"]) 
-            except requests.exceptions.RequestException as e:
-                print(f"Error sending request: {e}")
-            except Exception as e:
-                print(f"Unexpected error: {e}")
-
         
     def store(self, label: str, data: dict, ctx: Optional[str] = None):
         if ctx:
@@ -429,21 +412,21 @@ class Cell:
 
 
     def sign_contract(self, contractID: str):
-        full_url = f"https://{self.network}/api/sign_contract"
-        
-        sign_contract = {
-            "contractID": contractID,
-            "cell": self.to_dict() 
-        }
+            full_url = f"https://{self.network}/api/sign_contract"
+            
+            sign_contract = {
+                "contractID": contractID,
+                "cell": self.to_dict() 
+            }
 
-        try:
-            response = requests.post(full_url, json=sign_contract)
-            response.raise_for_status()
-            return response.json()["token"]
-        except requests.exceptions.RequestException as e:
-            print(f"Error sending request: {e}")
-        except Exception as e:
-            print(f"Unexpected error: {e}")
+            try:
+                response = requests.post(full_url, json=sign_contract)
+                response.raise_for_status()
+                return response.json()["token"]
+            except requests.exceptions.RequestException as e:
+                print(f"Error sending request: {e}")
+            except Exception as e:
+                print(f"Unexpected error: {e}")
 
 
     def validate_token(self, token: str, cp: str, contractID: str):
@@ -559,7 +542,4 @@ class Cell:
             print(f"Unexpected error: {e}")
 
 
-
-
-
 __all__ = ['Cell']

{neuronum-1.6.0.dist-info → neuronum-1.7.0.dist-info}/METADATA

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: neuronum
-Version: 1.6.0
-Summary: Interact with the Neuronum Network to build & automate interconnected networks of soft- and hardware components
+Version: 1.7.0
+Summary: Official client library to interact with the Neuronum Network
 Home-page: https://neuronum.net
 Author: Neuronum Cybernetics
 Author-email: welcome@neuronum.net
@@ -9,7 +9,7 @@ Project-URL: GitHub, https://github.com/neuronumcybernetics/neuronum
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
-Requires-Python: >=3.6
+Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: requests
@@ -22,75 +22,85 @@ Requires-Dist: python-dotenv
 
 [![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)
 
-`Neuronum` is a cybernetic framework enabling businesses to build & automate interconnected networks of soft- and hardware components
+Build, deploy and automate IoT connectivity with `Neuronum`
 
 ## Features
-- **Cell**: Identity to connect and interact with the Neuronum Network
-- **Nodes/Node-CLI**: Setup and manage Neuronum Nodes from the command line.
+- **Cells/Cell-CLI**: Create and manage Neuronum Cells from the command line
+- **Nodes/Node-CLI**: Setup and manage Neuronum Nodes from the command line
 - **Transmitters (TX)**: Automate economic data transfer
 - **Circuits (CTX)**: Store data in Key-Value-Label databases
 - **Streams (STX)**: Stream, synchronize and control data in real time
-- **Contracts/Tokens**: Automate contract-based authorization between Nodes and Cells
-
+- **Contracts/Tokens**: Automate services exchange and authorization between Cells and Nodes
 
 ### Installation
 Install the Neuronum library using pip:
-```python
-pip install neuronum
+```sh
+$ pip install neuronum
 ```
 
-### Cell
-To interact with the Network you will need to create a Neuronum Cell. 
-Create your Cell: [Create Cell](https://neuronum.net/createcell)
+### Cells/Cell-CLI
+To interact with the Neuronum Network, you must first create a Neuronum Cell
 
-Set and test Cell connection:
-```python
-import neuronum
+Create Cell:
+```sh
+$ neuronum create-cell  
+```
+
+Connect Cell:
+```sh
+$ neuronum connect-cell  
+```
+
+View connected Cell:
+```sh
+$ neuronum view-cell   
+```
+
+Disconnect Cell:
+```sh
+$ neuronum disconnect-cell  
+```
 
-cell = neuronum.Cell(
-host="host::cell",                                                # cell host 
-password="your_password",                                         # cell password 
-network="neuronum.net",                                           # cell network 
-synapse="your_synapse"                                            # cell synapse
-)           
-cell.connect()                                                    # connect to network
+Delete Cell:
+```sh
+$ neuronum delete-cell  
 ```
 
 ### Nodes/Node-CLI
-Neuronum Nodes are computing hardware powered by the Neuronum library, enabling seamless communication between Nodes and Cells.
+Neuronum Nodes are soft- and hardware components that power the Neuronum Network, enabling seamless communication between Nodes and Cells
 
-Initialize your Node:
-```bash
->>> neuronum init-node   
+Initialize a Node:
+```sh
+$ neuronum init-node                                              # neuronum init-node --sync id::stx (optional)  
 ```
 
-Start your Node:
-```bash
->>> neuronum start-node   
+Start a Node:
+```sh
+$ neuronum start-node   
 ```
 
-Stop your Node:
-```bash
->>> neuronum stop-node   
+Stop a Node:
+```sh
+$ neuronum stop-node   
 ```
 
-Register your Node on the Neuronum Network:
-```bash
->>> neuronum register-node   
+Register a Node on the Neuronum Network:
+```sh
+$ neuronum register-node   
 ```
 
-Update your Node:
-```bash
->>> neuronum update-node   
+Update a Node:
+```sh
+$ neuronum update-node   
 ```
 
-Delete your Node:
-```bash
->>> neuronum delete-node   
+Delete a Node:
+```sh
+$ neuronum delete-node   
 ```
 
 ### Transmitters (TX)
-Transmitters (TX) are used to create predefined templates to receive and send data in a standardized format.
+Transmitters (TX) are used to create predefined templates to receive and send data in a standardized format
 
 Create Transmitter (TX):
 ```python
@@ -283,15 +293,15 @@ stxList = cell.list_stx()                                         # list Streams
 ```
 
 ### Contracts/Tokens
-Contracts define rules for authorization, allowing users to sign and generate unique tokens for secure access
+Contracts are predefined token-based rules to automate service exchange and authorization between Cells and Nodes
 
 Create a Contract:
 ```python
 descr = "Test Contract"                                           # short description (max 25 characters)
 details = {                                                       # define token details
-    "price_in_eur": 10,                                           # token price in EUR
-    "max_usage": 10,                                              # max number of uses
-    "validity_in_min": 10                                         # token expiration time (minutes)
+    "price_in_eur": False,                                        # token price in EUR (int, float or False)
+    "max_usage": False,                                           # max number of uses (int or False)
+    "validity_in_min": False                                      # token expiration time in min (int, float or False)
     }          
 partners = ["id::cell", "id::cell"]           
 contractID = cell.create_contract(descr, details, partners)

neuronum-1.7.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cli/main.py,sha256=w4pNMA7ySCKTk4Z-Mb3W7cIw5ZUpLrP92L2HfrcFxSM,17637
+neuronum/__init__.py,sha256=Drsm263_w3_VWgl1YsKLUr8WwVodqV3TSjqpxLjyq_M,46
+neuronum/neuronum.py,sha256=4j3fV7VHPb1KcQucOEDBQ-v2SoG9c2WfGPqMfI3OF88,16498
+neuronum-1.7.0.dist-info/LICENSE,sha256=UiZjNHiCyRP6WoZfbYQh9cv4JW96wIofKXmzBJrYSUk,1125
+neuronum-1.7.0.dist-info/METADATA,sha256=GqgpO0lCzLKJwOfNRH8GzXPbRgsvRvZm3YP5FPVMbNs,12806
+neuronum-1.7.0.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
+neuronum-1.7.0.dist-info/entry_points.txt,sha256=XKYBcRNxGeJpZZkDPsa8HA_RaJ7Km_R_JaUq5T9Nk2U,42
+neuronum-1.7.0.dist-info/top_level.txt,sha256=ru8Fr84cHm6oHr_DcJ8-uaq3RTiuCRFIr6AC8V0zPu4,13
+neuronum-1.7.0.dist-info/RECORD,,

neuronum-1.6.0.dist-info/RECORD

@@ -1,10 +0,0 @@
-cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-cli/main.py,sha256=wD5wj2qy-VKwrx9CWoHbxmERSO1Z11B59oMJc49GM9E,9449
-neuronum/__init__.py,sha256=Drsm263_w3_VWgl1YsKLUr8WwVodqV3TSjqpxLjyq_M,46
-neuronum/neuronum.py,sha256=qJqYpVoKdUw0YOa7aMp85QSOflkn8R7sqF5dIlTkBe0,16993
-neuronum-1.6.0.dist-info/LICENSE,sha256=UiZjNHiCyRP6WoZfbYQh9cv4JW96wIofKXmzBJrYSUk,1125
-neuronum-1.6.0.dist-info/METADATA,sha256=BblXzU3CeyyrTzdEyj0K--RnillyBYhNi-61mao50HA,13089
-neuronum-1.6.0.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
-neuronum-1.6.0.dist-info/entry_points.txt,sha256=XKYBcRNxGeJpZZkDPsa8HA_RaJ7Km_R_JaUq5T9Nk2U,42
-neuronum-1.6.0.dist-info/top_level.txt,sha256=ru8Fr84cHm6oHr_DcJ8-uaq3RTiuCRFIr6AC8V0zPu4,13
-neuronum-1.6.0.dist-info/RECORD,,