Skip to main content

Neuronum SDK

Project description

Neuronum

Neuronum SDK

Website Documentation PyPI Version
Python Version License


About

Neuronum is a real-time, end-to-end encrypted data network. Transmit and receive data between any two points without managing backend infrastructure.

⚠️ 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

Setup 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.

Create a Cell (your Neuronum ID):

neuronum create-cell

How it works

Every participant on the network is a Cell — a unique, encrypted identity. Every Cell can communicate with any other Cell on the network. All you need is the recipient's Cell ID.

Cells interact using four core methods:

Method Description
list_cells() Get a list of all Cells
stream(data, cell_id) Send data to a Cell (defaults to own Cell)
activate_tx(data, cell_id) Send a request and wait for a response (defaults to own Cell)
sync() Listen for incoming transmissions
tx_response(transmitter_id, data, public_key) Send an encrypted response back

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


Quick Example

Stream data (fire-and-forget)

import asyncio
from neuronum import Cell

async def main():
    async with Cell() as cell:
        await cell.stream(
          {"msg": "Ping"},
          cell_id="receiver_cell_id"
        )

asyncio.run(main())

Send data & wait for response

import asyncio
from neuronum import Cell

async def main():
    async with Cell() as cell:
        tx_response = await cell.activate_tx(
          {"msg": "Ping"},
          cell_id="receiver_cell_id"
        )
        print(tx_response)

asyncio.run(main())

Receive data & send response

import asyncio
from neuronum import Cell

async def main():
    async with Cell() as cell:
        async for tx in cell.sync():
            data = tx.get("data", {})

            await cell.tx_response(
                tx.get("transmitter_id"),
                {"msg": "Pong"},
                data.get("public_key", "")
            )

asyncio.run(main())

TX (Transmitter) Object

When you receive data via sync(), each transmission arrives as a TX object:

{
    "transmitter_id": "bfd2a0d009c6f784ec97c41d3738a24e0e5ac8f1",
    "time": "1772923393",
    "operator": "1uRQdV593S91E3T2-Vj_29mxBJoI7Cvxxg6dNFDVfv4::cell",
    "data": {
        "msg": "Ping",
        "public_key": "-----BEGIN PUBLIC KEY-----\n..."
    }
}

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.3.3.tar.gz (16.3 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.3.3-py3-none-any.whl (15.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for neuronum-2026.3.3.tar.gz
Algorithm Hash digest
SHA256 076ad01c41a8a151db56c49e0c1116b46d0e5252f37efbd3f3fb8e49d967000e
MD5 3a36cd5ecad66e680f4928b75fd8075e
BLAKE2b-256 81be619c690233743127c3447b07befa5d92314f1145ed11f1d2971381d3e3c9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: neuronum-2026.3.3-py3-none-any.whl
  • Upload date:
  • Size: 15.9 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.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 c4f81a15a05227421c8f58d0e457e6d41f97eae517dd876189ff012707cfbe64
MD5 1a28931c3a923d1bbd1867417c073947
BLAKE2b-256 dd540cc8d9dfa2538e728d6d4a2a8814dd03b965e420822d939adc10d30da6e7

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