neuronum 2.0.4__tar.gz → 12.0.0__tar.gz

neuronum-2.0.4/LICENSE → neuronum-12.0.0/LICENSE.md

@@ -1,21 +1,47 @@
-MIT License
-
-Copyright (c) [2025] [Neuronum Cybernetics UG (limited liability)]
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+<h1 align="center">
+  <img src="https://neuronum.net/static/neuronum.svg" alt="Neuronum" width="80">
+</h1>
+<h4 align="center">LICENSE of the Neuronum library</h4>
+
+<p align="center">
+  <a href="https://neuronum.net">
+    <img src="https://img.shields.io/badge/Website-Neuronum-blue" alt="Website">
+  </a>
+  <a href="https://github.com/neuronumcybernetics/neuronum">
+    <img src="https://img.shields.io/badge/Docs-Read%20now-green" alt="Documentation">
+  </a>
+  <a href="https://pypi.org/project/neuronum/">
+    <img src="https://img.shields.io/pypi/v/neuronum.svg" alt="PyPI Version">
+  </a>
+  <img src="https://img.shields.io/badge/Python-3.8%2B-yellow" alt="Python Version">
+  <a href="https://github.com/neuronumcybernetics/neuronum/blob/main/LICENSE.md">
+    <img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License">
+  </a>
+</p>
+
+---
+
+MIT License
+
+Copyright (c) 2025 Neuronum Cybernetics UG (limited liability)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+
+

neuronum-12.0.0/PKG-INFO

@@ -0,0 +1,206 @@
+Metadata-Version: 2.4
+Name: neuronum
+Version: 12.0.0
+Summary: Official Neuronum Tools Library
+Home-page: https://neuronum.net
+Author: Neuronum Cybernetics
+Author-email: welcome@neuronum.net
+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.8
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: aiohttp
+Requires-Dist: aiofiles
+Requires-Dist: websockets
+Requires-Dist: click
+Requires-Dist: questionary
+Requires-Dist: python-dotenv
+Requires-Dist: requests
+Requires-Dist: cryptography
+Requires-Dist: bip_utils
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+<h1 align="center">
+  <img src="https://neuronum.net/static/neuronum.svg" alt="Neuronum" width="80">
+</h1>
+<h4 align="center">Neuronum Tools Library</h4>
+
+<p align="center">
+  <a href="https://neuronum.net">
+    <img src="https://img.shields.io/badge/Website-Neuronum-blue" alt="Website">
+  </a>
+  <a href="https://github.com/neuronumcybernetics/neuronum">
+    <img src="https://img.shields.io/badge/Docs-Read%20now-green" alt="Documentation">
+  </a>
+  <a href="https://pypi.org/project/neuronum/">
+    <img src="https://img.shields.io/pypi/v/neuronum.svg" alt="PyPI Version">
+  </a><br>
+  <img src="https://img.shields.io/badge/Python-3.8%2B-yellow" alt="Python Version">
+  <a href="https://github.com/neuronumcybernetics/neuronum/blob/main/LICENSE.md">
+    <img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License">
+  </a>
+</p>
+
+------------------
+
+### **Getting Started**
+In this brief getting started guide, you will:
+- [Learn about Neuronum Tools](#about-neuronum-tools)
+- [Connect to Neuronum](#connect-to-neuronum)
+- [Initialize a Tool](#initialize-a-tool)
+- [Update a Tool](#update-a-tool)
+- [Delete a Tool](#delete-a-tool)
+
+------------------
+
+### **About Neuronum Tools**
+Neuronum Tools serve as plug and play Servers/Applications that allow ceLLai to connect to external data sources and systems. Neuronum Tools follow standardized MCP (Model Context Protocol) guidelines. 
+
+### Requirements
+- Python >= 3.8
+
+------------------
+
+### **Connect To Neuronum**
+**Installation** (optional but recommended: create a virtual environment)
+```sh
+pip install neuronum
+```
+
+Create your Cell (your secure identity):
+```sh
+neuronum create-cell
+```
+
+or
+
+Connect an existing Cell (your secure identity):
+```sh
+neuronum connect-cell
+```
+
+------------------
+
+
+### **Initialize a Tool** 
+```sh
+neuronum init-tool
+```
+You will be prompted to enter a tool name and description (e.g., "Test Tool" and "A simple test tool"). This will create a new folder named using the format: `Tool Name_ToolID` (e.g., `Test Tool_019ac60e-cccc-7af5-b087-f6fcf1ba1299`)
+
+This folder will contain 2 files:
+1. **tool.config** - Configuration and metadata for your tool
+2. **tool.py** - Your Tool/MCP server implementation
+
+**Example tool.config:**
+```config
+{
+  "tool_meta": {
+    "tool_id": "019ac60e-cccc-7af5-b087-f6fcf1ba1299",
+    "version": "1.0.0",
+    "name": "Test Tool",
+    "description": "A simple test tool",
+    "audience": "private",
+    "logo": "https://neuronum.net/static/logo_new.png"
+  },
+  "legals": {
+    "terms": "https://url_to_your/terms",
+    "privacy_policy": "https://url_to_your/privacy_policy"
+  },
+  "requirements": [],
+  "variables": []
+}
+```
+
+**Example tool.py:**
+```python
+"""
+Simple Standardized MCP Server Example
+Demonstrates the official MCP protocol with stdio transport.
+"""
+
+import asyncio
+import json
+from mcp.server import Server
+from mcp.server.stdio import stdio_server
+from mcp.types import Tool, TextContent
+
+# Create server instance
+app = Server("simple-example")
+
+
+@app.list_tools()
+async def list_tools() -> list[Tool]:
+    """List available tools using standard MCP protocol."""
+    return [
+        Tool(
+            name="echo",
+            description="Echo back a message",
+            inputSchema={
+                "type": "object",
+                "properties": {
+                    "message": {
+                        "type": "string",
+                        "description": "Message to echo back"
+                    }
+                },
+                "required": ["message"]
+            }
+        )
+    ]
+
+
+@app.call_tool()
+async def call_tool(name: str, arguments: dict) -> list[TextContent]:
+    """Handle tool calls using standard MCP protocol."""
+
+    if name == "echo":
+        message = arguments.get("message", "")
+        return [TextContent(
+            type="text",
+            text=f"Echo: {message}"
+        )]
+
+    else:
+        raise ValueError(f"Unknown tool: {name}")
+
+
+async def main():
+    """Run the MCP server with stdio transport."""
+    async with stdio_server() as (read_stream, write_stream):
+        await app.run(
+            read_stream,
+            write_stream,
+            app.create_initialization_options()
+        )
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+
+### **Update a Tool**
+After modifying your `tool.config` or `tool.py` files, submit the updates using:
+```sh
+neuronum update-tool
+```
+
+### **Delete a Tool**
+To remove a tool from Neuronum:
+```sh
+neuronum delete-tool
+```

neuronum-12.0.0/README.md

@@ -0,0 +1,171 @@
+<h1 align="center">
+  <img src="https://neuronum.net/static/neuronum.svg" alt="Neuronum" width="80">
+</h1>
+<h4 align="center">Neuronum Tools Library</h4>
+
+<p align="center">
+  <a href="https://neuronum.net">
+    <img src="https://img.shields.io/badge/Website-Neuronum-blue" alt="Website">
+  </a>
+  <a href="https://github.com/neuronumcybernetics/neuronum">
+    <img src="https://img.shields.io/badge/Docs-Read%20now-green" alt="Documentation">
+  </a>
+  <a href="https://pypi.org/project/neuronum/">
+    <img src="https://img.shields.io/pypi/v/neuronum.svg" alt="PyPI Version">
+  </a><br>
+  <img src="https://img.shields.io/badge/Python-3.8%2B-yellow" alt="Python Version">
+  <a href="https://github.com/neuronumcybernetics/neuronum/blob/main/LICENSE.md">
+    <img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License">
+  </a>
+</p>
+
+------------------
+
+### **Getting Started**
+In this brief getting started guide, you will:
+- [Learn about Neuronum Tools](#about-neuronum-tools)
+- [Connect to Neuronum](#connect-to-neuronum)
+- [Initialize a Tool](#initialize-a-tool)
+- [Update a Tool](#update-a-tool)
+- [Delete a Tool](#delete-a-tool)
+
+------------------
+
+### **About Neuronum Tools**
+Neuronum Tools serve as plug and play Servers/Applications that allow ceLLai to connect to external data sources and systems. Neuronum Tools follow standardized MCP (Model Context Protocol) guidelines. 
+
+### Requirements
+- Python >= 3.8
+
+------------------
+
+### **Connect To Neuronum**
+**Installation** (optional but recommended: create a virtual environment)
+```sh
+pip install neuronum
+```
+
+Create your Cell (your secure identity):
+```sh
+neuronum create-cell
+```
+
+or
+
+Connect an existing Cell (your secure identity):
+```sh
+neuronum connect-cell
+```
+
+------------------
+
+
+### **Initialize a Tool** 
+```sh
+neuronum init-tool
+```
+You will be prompted to enter a tool name and description (e.g., "Test Tool" and "A simple test tool"). This will create a new folder named using the format: `Tool Name_ToolID` (e.g., `Test Tool_019ac60e-cccc-7af5-b087-f6fcf1ba1299`)
+
+This folder will contain 2 files:
+1. **tool.config** - Configuration and metadata for your tool
+2. **tool.py** - Your Tool/MCP server implementation
+
+**Example tool.config:**
+```config
+{
+  "tool_meta": {
+    "tool_id": "019ac60e-cccc-7af5-b087-f6fcf1ba1299",
+    "version": "1.0.0",
+    "name": "Test Tool",
+    "description": "A simple test tool",
+    "audience": "private",
+    "logo": "https://neuronum.net/static/logo_new.png"
+  },
+  "legals": {
+    "terms": "https://url_to_your/terms",
+    "privacy_policy": "https://url_to_your/privacy_policy"
+  },
+  "requirements": [],
+  "variables": []
+}
+```
+
+**Example tool.py:**
+```python
+"""
+Simple Standardized MCP Server Example
+Demonstrates the official MCP protocol with stdio transport.
+"""
+
+import asyncio
+import json
+from mcp.server import Server
+from mcp.server.stdio import stdio_server
+from mcp.types import Tool, TextContent
+
+# Create server instance
+app = Server("simple-example")
+
+
+@app.list_tools()
+async def list_tools() -> list[Tool]:
+    """List available tools using standard MCP protocol."""
+    return [
+        Tool(
+            name="echo",
+            description="Echo back a message",
+            inputSchema={
+                "type": "object",
+                "properties": {
+                    "message": {
+                        "type": "string",
+                        "description": "Message to echo back"
+                    }
+                },
+                "required": ["message"]
+            }
+        )
+    ]
+
+
+@app.call_tool()
+async def call_tool(name: str, arguments: dict) -> list[TextContent]:
+    """Handle tool calls using standard MCP protocol."""
+
+    if name == "echo":
+        message = arguments.get("message", "")
+        return [TextContent(
+            type="text",
+            text=f"Echo: {message}"
+        )]
+
+    else:
+        raise ValueError(f"Unknown tool: {name}")
+
+
+async def main():
+    """Run the MCP server with stdio transport."""
+    async with stdio_server() as (read_stream, write_stream):
+        await app.run(
+            read_stream,
+            write_stream,
+            app.create_initialization_options()
+        )
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+
+### **Update a Tool**
+After modifying your `tool.config` or `tool.py` files, submit the updates using:
+```sh
+neuronum update-tool
+```
+
+### **Delete a Tool**
+To remove a tool from Neuronum:
+```sh
+neuronum delete-tool
+```