nelieo-nsp Python SDK: Package and Symbol Reference

pip install nelieo-nsp

nelieo_nsp/
├── __init__.py      # Public API — all exported symbols re-exported here
├── client.py        # NSPClient — the primary entry point
├── session.py       # NSPSession, CLRSessionProxy, JVMSessionProxy
├── models.py        # Pydantic data models: SubstrateState, ActionSchema, ...
├── watch.py         # StateStream and open_state_stream (streaming)
└── exceptions.py    # Full exception hierarchy

from nelieo_nsp import (
    # Primary client
    NSPClient,

    # Session interfaces
    NSPSession,
    CLRSessionProxy,          # .NET helpers — accessed as session.clr
    JVMSessionProxy,          # Java helpers — accessed as session.jvm

    # Data models
    SubstrateState,           # Full state snapshot for a process
    AppSummary,               # Lightweight descriptor returned by list_apps()
    ActionSchema,             # Metadata and signature for a single action
    ActionParameter,          # Parameter descriptor within ActionSchema
    ActionRequest,            # Low-level action dispatch request body
    ActionResponse,           # Result returned by execute() / execute_action()
    VerificationResult,       # Post-action verification outcome
    StateChangeNotification,  # Single event yielded by StateStream

    # Enums
    RuntimeKind,              # v8 | jvm | clr | native | unknown
    Reversibility,            # read | reversible_write | irreversible_write

    # Streaming
    StateStream,              # Async iterator of StateChangeNotification

    # Exceptions
    NSPError,
    NSPAuthError,
    NSPConnectionError,
    NSPNotFoundError,
    NSPRateLimitError,
    NSPTimeoutError,
    NSPConfidenceTooLowError,
    NSPIrreversibleNotConfirmedError,
)

# API key — required unless you pass api_key= to NSPClient directly
export NSP_API_KEY=sk_nsp_a1b2c3...

# Daemon host — defaults to 127.0.0.1
export NSP_HOST=127.0.0.1

# Daemon port — defaults to 7842
export NSP_PORT=7842

import nelieo_nsp as nsp

async with nsp.NSPClient() as client:   # reads NSP_API_KEY from environment
    apps = await client.list_apps()

import asyncio
import nelieo_nsp as nsp

async def main():
    # ── Connect ──────────────────────────────────────────────────────────
    async with nsp.NSPClient(api_key="sk_nsp_...") as client:

        # ── Discover tracked applications ─────────────────────────────
        apps = await client.list_apps()
        for app in apps:
            print(f"{app.app_name}  pid={app.pid}  conf={app.confidence:.2f}")

        # ── Attach to an app by name ───────────────────────────────────
        session = await client.attach("Gmail")

        # ── Read typed state values ────────────────────────────────────
        unread  = session.get_int("inbox.unread_count")
        subject = session.get_str("inbox.emails[0].subject")
        print(f"Unread: {unread}  Latest: {subject}")

        # ── Inspect available actions ──────────────────────────────────
        for name, schema in session.actions.items():
            print(f"  {name}: {schema.signature}  [{schema.reversibility}]")

        # ── Execute an action ──────────────────────────────────────────
        result = await session.execute(
            "archive",
            parameters={"email_id": session.get_str("inbox.emails[0].id")},
        )
        print(f"Archived: {result.success}  latency={result.latency_ms}ms")

        # ── Stream real-time state changes ─────────────────────────────
        async with session.watch() as stream:
            async for event in stream:
                print(f"Changed keys: {event.changed_keys}")
                await session.refresh()
                break  # one event for demo

asyncio.run(main())