Skip to main content

Neuronum SDK

Project description

Neuronum

Neuronum SDK

Website Documentation PyPI Version
Python Version License


About

Neuronum enables business partners to connect their distributed AI agents and communicate across devices through a Secure Agent Session (SAS). The framework provides built‑in end‑to‑end encryption, identity management, and message delivery through simple function calls.

⚠️ Development Status: The Neuronum SDK is currently in beta and is not production-ready. It is intended for development, testing, and experimental purposes only. Do not use in production environments or for critical applications.


Requirements

  • Python >= 3.8

Installation

Set up and activate a virtual environment:

python3 -m venv ~/neuronum-venv
source ~/neuronum-venv/bin/activate

Install the Neuronum SDK:

pip install neuronum

Note: Always activate this virtual environment (source ~/neuronum-venv/bin/activate) before running any neuronum commands.


Cell

A Cell is your address used to send and receive data on the Neuronum network. You can think of it like a unique digital identity.

Example IDs: acme.com::cell johndoe@acme.com::cell

Create a Cell:

neuronum create-cell

This generates your Cell ID, public/private key pair, and a 12-word mnemonic recovery phrase. Your Cell credentials are stored locally at ~/.neuronum/.env.

Connect your Cell to a device using your 12-word mnemonic:

neuronum connect-cell

View the connected Cell ID:

neuronum view-cell

Disconnect Cell credentials from this device:

neuronum disconnect-cell

Delete your Cell permanently from the network:

neuronum delete-cell

Methods

Cells interact using five methods:

Method Description
list_cells() List all Neuronum Cells
list_sessions() List your Secure Agent Sessions (SAS)
create_secure_agent_session(cell_id or email_address) Create and invite to a session
send_session_message(session_id, data) Send an encrypted message to a session
get_session_messages(session_id) Fetch and decrypt messages from a session

All data is end-to-end encrypted. The network handles routing, key exchange, and delivery. You just send and receive.

Connecting to the network: Use async with Cell(network="testnet.neuronum.net") as cell to connect. This reads your Cell credentials from ~/.neuronum/.env and establishes a connection to the specified Neuronum network. Omitting the network parameter defaults to testnet.neuronum.net.


Quick Examples

List Cells

import asyncio
from neuronum import Cell

async def main():
    async with Cell(network="testnet.neuronum.net") as cell:
        cells = await cell.list_cells()
        print(cells)

asyncio.run(main())

List Sessions

import asyncio
from neuronum import Cell

async def main():
    async with Cell(network="testnet.neuronum.net") as cell:
        sessions = await cell.list_sessions()
        print(sessions)

asyncio.run(main())

Create a Secure Agent Session

import asyncio
from neuronum import Cell

async def main():
    async with Cell(network="testnet.neuronum.net") as cell:
        session = await cell.create_secure_agent_session(
            receiver_cell_id="receiver.com::cell"
        )
        print(session)

asyncio.run(main())

Send a message to a session

import asyncio
from neuronum import Cell

async def main():
    async with Cell(network="testnet.neuronum.net") as cell:
        success = await cell.send_session_message(
            "session_id",
            {"msg": "Hello"}
        )
        print(success)

asyncio.run(main())

Fetch messages from a session

import asyncio
from neuronum import Cell

async def main():
    async with Cell(network="testnet.neuronum.net") as cell:
        async for tx in cell.get_session_messages("session_id"):
            print(tx)

asyncio.run(main())

TX (Transmitter) Object

When you fetch data via get_session_messages, each payload arrives as a TX object:

{
    "tx_id": "bfd2a0d009c6f784ec97c41d3738a24e0e5ac8f1",
    "time": "1772923393",
    "sender": "acme.com::cell",
    "data": {
        "msg": "Hello World!",
        "public_key": "-----BEGIN PUBLIC KEY-----\n..."
    }
}
Field Description
tx_id Unique payload ID generated from the encrypted data context and timestamp
time Unix timestamp of the transmission
sender The sender's Cell ID
data The decrypted payload, including the sender's public key

Neuronum MCP Server

neuronum neuronum start-mcp

Full Documentation

For the complete SDK reference including the E2EE protocol, visit the Neuronum Docs.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

neuronum-2026.6.3.tar.gz (17.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

neuronum-2026.6.3-py3-none-any.whl (17.3 kB view details)

Uploaded Python 3

File details

Details for the file neuronum-2026.6.3.tar.gz.

File metadata

  • Download URL: neuronum-2026.6.3.tar.gz
  • Upload date:
  • Size: 17.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for neuronum-2026.6.3.tar.gz
Algorithm Hash digest
SHA256 1da3beec73bff01d2f52531d693af0603855984e315baed89b34cfc495776e9b
MD5 9e569cec3dff5d51fc233bdd6caa42b3
BLAKE2b-256 4b77766c78b2b96b29b73f6fa99cf471f1fd5b32e9890dec3afdb2dcd7f2e605

See more details on using hashes here.

File details

Details for the file neuronum-2026.6.3-py3-none-any.whl.

File metadata

  • Download URL: neuronum-2026.6.3-py3-none-any.whl
  • Upload date:
  • Size: 17.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for neuronum-2026.6.3-py3-none-any.whl
Algorithm Hash digest
SHA256 dd3795f64bf99353d8dfd0ebadf2b1a9801d39937b69e1a1ef61b2bd4622ac93
MD5 79fd29099a5afde92c121493a6d5760e
BLAKE2b-256 403ca24745a4d6030ce87e3479f4b7fa6eb1c6eb64aaed6ed3728c65cd765e74

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page