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.2.tar.gz (15.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.2-py3-none-any.whl (14.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: neuronum-2026.3.2.tar.gz
  • Upload date:
  • Size: 15.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.2.tar.gz
Algorithm Hash digest
SHA256 5ea4b34dcc40447a1b1eebea0d3a4e2fcf8124ab573ee5204ac9968df087e9e2
MD5 1d91acbfdbc6734c68956193fc3bf6a5
BLAKE2b-256 e4e7562250cc5374bb217442a5f074a6257061a7c1dd359e6d20284f4816a679

See more details on using hashes here.

File details

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

File metadata

  • Download URL: neuronum-2026.3.2-py3-none-any.whl
  • Upload date:
  • Size: 14.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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 37f17828a9e518cdcff93b1d9e439d183684c1ed4ca1878f1d95213b362b7ee9
MD5 445027b10ab2703eafc449f5e61bf0a5
BLAKE2b-256 06b634857ef5594a3d5ddb9c46cfe90caa0cd6a8b998d89f6f14afe5b3436f49

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