Skip to main content

An E2EE Data Engine

Project description

Neuronum

Neuronum: An E2EE Data Engine

Website Documentation PyPI Version
Python Version License


Getting Started into the Neuronum Network

In this brief getting started guide, you will:


About Neuronum

Neuronum is a real-time, end-to-end encrypted data engine built in Python. It enables secure communication between devices and services by encrypting data client-side using the recipient's public key. Encrypted messages are transmitted through a passive relay server and decrypted on the recipient’s device using its private key. The relay server facilitates connectivity but cannot access or alter the content of messages.

Requirements

  • Python >= 3.8

Connect To Neuronum

Installation (optional but recommended: create a virtual environment)

pip install neuronum

Create your Cell (your secure identity):

neuronum create-cell

or

Connect an existing Cell (your secure identity):

neuronum connect-cell

Transmit Data Securely

import asyncio
from neuronum import Cell

async def main():
    
    async with Cell() as cell: 

        data = {
            "some": "data"  # Replace with your actual payload
        }

        # Use activate_tx() if you expect a response from the other cell
        # Replace id with the actual Cell ID
        tx_response = await cell.activate_tx("id::cell", data)
        print(tx_response)

        # Stream data to another cell (no response expected)
        # Replace id with the actual Cell ID
        await cell.stream("id::cell", data)

if __name__ == '__main__':
    asyncio.run(main())

Receive Data Securely

import asyncio
from neuronum import Cell

async def main():
    async with Cell() as cell: 
        
        async for transmitter in cell.sync():
            ts_str = transmitter.get("time")
            data = transmitter.get("data")
            transmitter_id = transmitter.get("transmitter_id")   
            client_public_key = data.get("public_key", {})  

            response_data = {
                "json": "Data Received Securely - Your request was processed successfully",
                "html": """
                    <!DOCTYPE html>
                    <html lang="en">
                    <head>
                        <meta charset="UTF-8">
                        <title>Secure Data Response</title>
                    </head>
                    <body>
                        <h3>Data Received Securely</h3>
                        <p>Your request was processed successfully.</p>
                    </body>
                    </html>
                """
            }
            await cell.tx_response(transmitter_id, response_data, client_public_key)

if __name__ == '__main__':
    asyncio.run(main())

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for neuronum-10.1.0.tar.gz
Algorithm Hash digest
SHA256 687cce06d33760ab8e890edc7378743aa30b4bd1816d51828a3ebeb6a470858b
MD5 a76011c20c1dfea7fc1507addaf12fdc
BLAKE2b-256 04091ea4cc540728863e76647e6a0279039bfc9593e38bd3043d8b031221d77a

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for neuronum-10.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0ae936346e16a585da7ae69c109b354f08395627d040d43b4096e77f1961569d
MD5 d00f72ab33ba699125d4fa8535db67ae
BLAKE2b-256 2a1110a533cc0f982a23357369d09ed7efb40783fbfc5aca16fb583191fd8204

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