Skip to main content

Python SDK for the Neural Protocol Suite (NPS)

Project description

English | 中文版

NPS Python SDK (nps-lib)

License Release NCP NWP NIP NDP NOP

Python client library for the Neural Protocol Suite (NPS) — a complete internet protocol stack designed for AI agents and models.

PyPI package: nps-lib | Python namespace: nps_sdk

Status

v1.0.0-alpha.8 — tracking NPS suite alpha.8 (RFC-0005 ReputationPolicyEvaluator · cgn_limit enforcement)

Covers all five protocols — NCP + NWP + NIP + NDP + NOP — frame definitions, async client, Ed25519 identity management, plus full NPS-RFC-0002 X.509 + ACME agent-01 NID certificate primitives (nps_sdk.nip.x509 + nps_sdk.nip.acme). Alpha.8 tracks NPS suite alpha.8: RFC-0005 ReputationPolicyEvaluator in .NET SDK, cgn_limit pre-execution enforcement, RFC-0002 and RFC-0005 promoted to Accepted.

Tests: 221 across the SDK + RFC-0002/0003/0004 coverage, all passing.

Requirements

  • Python 3.11+
  • Dependencies: msgpack, httpx, cryptography

Installation

pip install nps-lib

For development:

pip install "nps-lib[dev]"

Modules

Module Description
nps_sdk.core Frame header, codec (Tier-1 JSON / Tier-2 MsgPack), anchor cache, exceptions
nps_sdk.ncp NCP frames: AnchorFrame, DiffFrame, StreamFrame, CapsFrame, HelloFrame, ErrorFrame
nps_sdk.nwp NWP frames: QueryFrame, ActionFrame; async NwpClient
nps_sdk.nip NIP frames: IdentFrame (v2 dual-trust), TrustFrame, RevokeFrame; NipIdentity (Ed25519); NipIdentVerifier + NipVerifierOptions (RFC-0002 §8.1 dual-trust); AssuranceLevel (RFC-0003)
nps_sdk.nip.x509 RFC-0002 X.509 NID certs: NipX509Builder / NipX509Verifier / NpsX509Oids
nps_sdk.nip.acme RFC-0002 ACME agent-01: AcmeClient / AcmeServer (in-process) / JWS helpers / messages
nps_sdk.ndp NDP frames: AnnounceFrame, ResolveFrame, GraphFrame; in-memory registry + validator
nps_sdk.nop NOP frames: TaskFrame, DelegateFrame, SyncFrame, AlignStreamFrame; async NopClient

Quick Start

Encoding / Decoding NCP Frames

from nps_sdk.core.codec import NpsFrameCodec
from nps_sdk.core.registry import FrameRegistry
from nps_sdk.ncp.frames import AnchorFrame, FrameSchema, SchemaField

registry = FrameRegistry.create_default()
codec    = NpsFrameCodec(registry)

schema = FrameSchema(fields=(
    SchemaField(name="id",    type="uint64"),
    SchemaField(name="price", type="decimal", semantic="commerce.price.usd"),
))
frame  = AnchorFrame(anchor_id="sha256:...", schema=schema)

wire   = codec.encode(frame)           # bytes — Tier-2 MsgPack by default
result = codec.decode(wire)            # → AnchorFrame

Anchor Cache (Schema Deduplication)

from nps_sdk.core.cache import AnchorFrameCache

cache     = AnchorFrameCache()
anchor_id = cache.set(frame)           # stores; returns canonical sha256 anchor_id
frame     = cache.get_required(anchor_id)

Querying a Memory Node (async)

import asyncio
from nps_sdk.nwp import NwpClient, QueryFrame

async def main():
    async with NwpClient("https://node.example.com") as client:
        caps = await client.query(
            QueryFrame(anchor_ref="sha256:...", limit=50)
        )
        print(caps.count, caps.data)

asyncio.run(main())

Invoking an Action Node (async)

from nps_sdk.nwp import NwpClient, ActionFrame

async with NwpClient("https://node.example.com") as client:
    result = await client.invoke(
        ActionFrame(action_id="orders.create", params={"sku": "X-101", "qty": 1})
    )

NIP Identity Management

from nps_sdk.nip.identity import NipIdentity

# Generate and save an encrypted Ed25519 keypair
identity = NipIdentity.generate("ca.key", passphrase="my-secret")

# Load from file
identity = NipIdentity()
identity.load("ca.key", passphrase="my-secret")

# Sign a NIP frame payload (canonical JSON, no 'signature' field)
sig = identity.sign(ident_frame.unsigned_dict())

# Verify
ok = NipIdentity.verify_signature(identity.pub_key_string, payload, sig)

Architecture

nps_sdk/
├── core/          # Wire primitives (FrameHeader, codec, cache, exceptions)
├── ncp/           # NCP frames (0x01–0x0F)
├── nwp/           # NWP frames (0x10–0x1F) + async HTTP client
└── nip/           # NIP frames (0x20–0x2F) + Ed25519 identity

Frame Encoding Tiers

Tier Value Description
Tier-1 JSON 0x00 UTF-8 JSON. Development / compatibility.
Tier-2 MsgPack 0x01 MessagePack binary. ~60% smaller. Production default.

NWP HTTP Overlay Mode

NwpClient communicates via HTTP with Content-Type: application/x-nps-frame. Sub-paths per operation:

Operation Path Request Frame Response Frame
Schema anchor POST /anchor AnchorFrame 204
Structured query POST /query QueryFrame CapsFrame
Streaming query POST /stream QueryFrame StreamFrame chunks
Action invocation POST /invoke ActionFrame raw result or AsyncActionResponse

Running Tests

pytest                 # all tests + coverage report
pytest -k test_nip     # NIP tests only

Coverage target: ≥ 90 %.

License

Apache 2.0 — see LICENSE.

Copyright 2026 INNO LOTUS PTY LTD

Project details


Download files

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

Source Distribution

nps_lib-1.0.0a8.tar.gz (133.1 kB view details)

Uploaded Source

Built Distribution

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

nps_lib-1.0.0a8-py3-none-any.whl (81.9 kB view details)

Uploaded Python 3

File details

Details for the file nps_lib-1.0.0a8.tar.gz.

File metadata

  • Download URL: nps_lib-1.0.0a8.tar.gz
  • Upload date:
  • Size: 133.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.2

File hashes

Hashes for nps_lib-1.0.0a8.tar.gz
Algorithm Hash digest
SHA256 ff289598a26fd52b4dc27b2db7af846a6dbb72b13471e8643b42bd00896ce869
MD5 63d7e014ead30b205e954399bded5dc6
BLAKE2b-256 9a5aba6b83e709f707c0e2359ddba09805cf71501378a617d3f9884547344344

See more details on using hashes here.

File details

Details for the file nps_lib-1.0.0a8-py3-none-any.whl.

File metadata

  • Download URL: nps_lib-1.0.0a8-py3-none-any.whl
  • Upload date:
  • Size: 81.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.2

File hashes

Hashes for nps_lib-1.0.0a8-py3-none-any.whl
Algorithm Hash digest
SHA256 d6e457fa707d7e416dcff26e30394a01f018e8e39603c450f1215956c91d5eba
MD5 118c0aaa051ca1161047bcf5a7e96996
BLAKE2b-256 665647b8b4de6031f80f6252dbe3a99aab755cca5cecd203e702ca9192300364

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