neuronum 1.5.1__tar.gz → 1.7.0__tar.gz

{neuronum-1.5.1 → neuronum-1.7.0}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: neuronum
-Version: 1.5.1
-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,52 +9,98 @@ 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
 Requires-Dist: websocket-client
+Requires-Dist: click
+Requires-Dist: questionary
+Requires-Dist: python-dotenv
 
 ![Neuronum Logo](https://neuronum.net/static/logo_pip.png "Neuronum")
 
-[![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)
-[![Tutorials](https://img.shields.io/badge/Tutorials-Watch%20now-red)](https://www.youtube.com/@neuronumnet)
+[![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
+- **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
-- **Nodes**: Soft-/Hardware components participating in the Network ecosystem
+- **Contracts/Tokens**: Automate services exchange and authorization between Cells and Nodes
 
-To interact with the Network you will need to create a Neuronum Cell. 
-Create your Cell: [Create Cell](https://neuronum.net/createcell)
+### Installation
+Install the Neuronum library using pip:
+```sh
+$ pip install neuronum
+```
 
+### Cells/Cell-CLI
+To interact with the Neuronum Network, you must first create a Neuronum Cell
 
-### Installation & Connection
-Start with installing the Neuronum library using pip:
-```python
-pip install neuronum
+Create Cell:
+```sh
+$ neuronum create-cell  
 ```
 
-Configure and test Cell connection:
-```python
-import neuronum
+Connect Cell:
+```sh
+$ neuronum connect-cell  
+```
+
+View connected Cell:
+```sh
+$ neuronum view-cell   
+```
+
+Disconnect Cell:
+```sh
+$ neuronum disconnect-cell  
+```
+
+Delete Cell:
+```sh
+$ neuronum delete-cell  
+```
+
+### Nodes/Node-CLI
+Neuronum Nodes are soft- and hardware components that power the Neuronum Network, enabling seamless communication between Nodes and Cells
+
+Initialize a Node:
+```sh
+$ neuronum init-node                                              # neuronum init-node --sync id::stx (optional)  
+```
+
+Start a Node:
+```sh
+$ neuronum start-node   
+```
+
+Stop a Node:
+```sh
+$ neuronum stop-node   
+```
 
-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
+Register a Node on the Neuronum Network:
+```sh
+$ neuronum register-node   
+```
+
+Update a Node:
+```sh
+$ neuronum update-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
@@ -87,10 +133,9 @@ TX = "id::tx"                                                     # select Trans
 cell.delete_tx(TX)                                                # delete TX
 ```
 
-List Transmitter (TX) from Cell:
-```python
-cellID = "id::cell"                                               # select Cell
-txList = cell.list_tx(cellID)                                     # list Transmitters (TX)
+List Transmitter (TX) your Cell can activate:
+```python                                            
+txList = cell.list_tx()                                           # list Transmitters (TX)
 ```
 
 ### Circuits (CTX)
@@ -177,10 +222,9 @@ CTX = "id::ctx"                                                   # select Circu
 cell.delete_ctx(CTX)                                              # delete CTX
 ```
 
-List Circuits (CTX) from Cell:
-```python
-cellID = "id::cell"                                               # select Cell
-ctxList = cell.list_ctx(cellID)                                   # list Circuits (CTX)
+List Circuits (CTX) your Cell can interact with:
+```python                                            
+ctxList = cell.list_ctx()                                         # list Circuits (CTX)
 ```
 
 ### Streams (STX)
@@ -243,25 +287,56 @@ for operation in stream:                                          # load stream
     operator = operation.get("operator")
 ```
 
-List Streams (STX) from Cell:
-```python
-cellID = "id::cell"                                               # select Cell
-stxList = cell.list_stx(cellID)                                   # list Streams (STX)
+List Streams (STX) your Cell can interact with:
+```python                                            
+stxList = cell.list_stx()                                         # list Streams (STX)
 ```
 
-### Nodes
-Neuronum Nodes are computing hardware running the Neuronum Client Library, enabling seamless data transmission, synchronization, and facilitating public Stream (STX) access
+### Contracts/Tokens
+Contracts are predefined token-based rules to automate service exchange and authorization between Cells and Nodes
 
-Register a Node with its associated Stream (STX):
+Create a Contract:
 ```python
-descr = "node_name"                                               # description (max 25 characters) 
-mode = "public"                                                   # "public" or "private" Node
-STX = "id::stx"                                                   # select Stream (STX)
-nodeID = cell.register_node(descr, mode, STX)                     # register Node
+descr = "Test Contract"                                           # short description (max 25 characters)
+details = {                                                       # define token details
+    "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)
 ```
 
-Delete Node:
-```python
-nodeID = "id::node"                                               # select Node
-cell.delete_node(nodeID)                                          # delete Node
+Sign a Contract:
+```python         
+contractID = "id::contract"                                       # select contract        
+token = cell.sign_contract(contractID)
+```
+
+Request a Token from another Cell to authorize a service:
+```python         
+cp = "id::cell"                                                   # select counterparty cell
+contractID = "id::contract"                                       # select contract  
+cell.request_token(cp, contractID)
+```
+
+Present a Token to another Cell to authorize a service:
+```python   
+token = "token"                                                   # select token
+cp = "id::cell"                                                   # select counterparty cell
+contractID = "id::contract"                                       # select the contract  
+cell.present_token(token, cp, contractID)
+```
+
+Validate a Token to authorize a service:
+```python   
+token = "token"                                                   # select token
+cp = "id::cell"                                                   # select counterparty cell
+contractID = "id::contract"                                       # select contract  
+cell.validate_token(token, cp, contractID)
+```
+
+List Contracts your Cell can interact with:
+```python                                                     
+contractList = cell.list_contracts()  
 ```

{neuronum-1.5.1 → neuronum-1.7.0}/README.md

@@ -1,43 +1,86 @@
 ![Neuronum Logo](https://neuronum.net/static/logo_pip.png "Neuronum")
 
-[![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)
-[![Tutorials](https://img.shields.io/badge/Tutorials-Watch%20now-red)](https://www.youtube.com/@neuronumnet)
+[![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
+- **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
-- **Nodes**: Soft-/Hardware components participating in the Network ecosystem
+- **Contracts/Tokens**: Automate services exchange and authorization between Cells and Nodes
 
-To interact with the Network you will need to create a Neuronum Cell. 
-Create your Cell: [Create Cell](https://neuronum.net/createcell)
+### Installation
+Install the Neuronum library using pip:
+```sh
+$ pip install neuronum
+```
 
+### Cells/Cell-CLI
+To interact with the Neuronum Network, you must first create a Neuronum Cell
 
-### Installation & Connection
-Start with installing the Neuronum library using pip:
-```python
-pip install neuronum
+Create Cell:
+```sh
+$ neuronum create-cell  
 ```
 
-Configure and test Cell connection:
-```python
-import neuronum
+Connect Cell:
+```sh
+$ neuronum connect-cell  
+```
+
+View connected Cell:
+```sh
+$ neuronum view-cell   
+```
+
+Disconnect Cell:
+```sh
+$ neuronum disconnect-cell  
+```
+
+Delete Cell:
+```sh
+$ neuronum delete-cell  
+```
+
+### Nodes/Node-CLI
+Neuronum Nodes are soft- and hardware components that power the Neuronum Network, enabling seamless communication between Nodes and Cells
+
+Initialize a Node:
+```sh
+$ neuronum init-node                                              # neuronum init-node --sync id::stx (optional)  
+```
+
+Start a Node:
+```sh
+$ neuronum start-node   
+```
+
+Stop a Node:
+```sh
+$ neuronum stop-node   
+```
 
-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
+Register a Node on the Neuronum Network:
+```sh
+$ neuronum register-node   
+```
+
+Update a Node:
+```sh
+$ neuronum update-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
@@ -70,10 +113,9 @@ TX = "id::tx"                                                     # select Trans
 cell.delete_tx(TX)                                                # delete TX
 ```
 
-List Transmitter (TX) from Cell:
-```python
-cellID = "id::cell"                                               # select Cell
-txList = cell.list_tx(cellID)                                     # list Transmitters (TX)
+List Transmitter (TX) your Cell can activate:
+```python                                            
+txList = cell.list_tx()                                           # list Transmitters (TX)
 ```
 
 ### Circuits (CTX)
@@ -160,10 +202,9 @@ CTX = "id::ctx"                                                   # select Circu
 cell.delete_ctx(CTX)                                              # delete CTX
 ```
 
-List Circuits (CTX) from Cell:
-```python
-cellID = "id::cell"                                               # select Cell
-ctxList = cell.list_ctx(cellID)                                   # list Circuits (CTX)
+List Circuits (CTX) your Cell can interact with:
+```python                                            
+ctxList = cell.list_ctx()                                         # list Circuits (CTX)
 ```
 
 ### Streams (STX)
@@ -226,25 +267,56 @@ for operation in stream:                                          # load stream
     operator = operation.get("operator")
 ```
 
-List Streams (STX) from Cell:
-```python
-cellID = "id::cell"                                               # select Cell
-stxList = cell.list_stx(cellID)                                   # list Streams (STX)
+List Streams (STX) your Cell can interact with:
+```python                                            
+stxList = cell.list_stx()                                         # list Streams (STX)
 ```
 
-### Nodes
-Neuronum Nodes are computing hardware running the Neuronum Client Library, enabling seamless data transmission, synchronization, and facilitating public Stream (STX) access
+### Contracts/Tokens
+Contracts are predefined token-based rules to automate service exchange and authorization between Cells and Nodes
 
-Register a Node with its associated Stream (STX):
+Create a Contract:
 ```python
-descr = "node_name"                                               # description (max 25 characters) 
-mode = "public"                                                   # "public" or "private" Node
-STX = "id::stx"                                                   # select Stream (STX)
-nodeID = cell.register_node(descr, mode, STX)                     # register Node
+descr = "Test Contract"                                           # short description (max 25 characters)
+details = {                                                       # define token details
+    "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)
 ```
 
-Delete Node:
-```python
-nodeID = "id::node"                                               # select Node
-cell.delete_node(nodeID)                                          # delete Node
+Sign a Contract:
+```python         
+contractID = "id::contract"                                       # select contract        
+token = cell.sign_contract(contractID)
+```
+
+Request a Token from another Cell to authorize a service:
+```python         
+cp = "id::cell"                                                   # select counterparty cell
+contractID = "id::contract"                                       # select contract  
+cell.request_token(cp, contractID)
+```
+
+Present a Token to another Cell to authorize a service:
+```python   
+token = "token"                                                   # select token
+cp = "id::cell"                                                   # select counterparty cell
+contractID = "id::contract"                                       # select the contract  
+cell.present_token(token, cp, contractID)
+```
+
+Validate a Token to authorize a service:
+```python   
+token = "token"                                                   # select token
+cp = "id::cell"                                                   # select counterparty cell
+contractID = "id::contract"                                       # select contract  
+cell.validate_token(token, cp, contractID)
 ```
+
+List Contracts your Cell can interact with:
+```python                                                     
+contractList = cell.list_contracts()  
+```