nimbus-dev-sdk
The MIT-licensed, dependency-free authoring contract for Nimbus connectors and extensions — Python binding.
pip install nimbus-dev-sdk # note: nimbus-dev-sdk, NOT nimbus-sdk
import nimbus_sdk # the import name differs from the distribution name
PyPI has a flat namespace and nimbus-sdk belongs to an unrelated project, so the
distribution is published as nimbus-dev-sdk.
What this is
The contract is defined once, language-neutrally, in
docs/spec/. This
package carries that specification data and binds it to Python. The
TypeScript SDK is the reference
implementation; both are held to the same conformance corpus.
The specification data is bundled into the distribution, so it is available without a network call or a checkout:
from nimbus_sdk import load_schema, negotiate_contract_version
schema = load_schema("nimbus-item.schema.json")
result = negotiate_contract_version(["1"], ["1"]) # NegotiationOk(version="1")
Status
Early. This release carries the contract-version constants, the negotiation algorithm,
and the published JSON Schemas. It also carries the IPC surface —
from nimbus_sdk.ipc import NdjsonLineReader, parse_hello, perform_handshake —
deliberately a separate import root from nimbus_sdk, mirroring the . vs ./ipc
split the TypeScript package publishes. It is not yet the full connector-authoring
surface — see the
roadmap.
perform_handshake is the one exchange this package performs end to end: write our
hello, read the peer's, agree on a contract major or refuse. The stream is injected,
never opened — the package does no I/O of its own — and a refusal comes back as a value,
because nothing here owns a process to exit.
from nimbus_sdk.ipc import HandshakeOk, NdjsonLineReader, perform_handshake
# `io` is any object with `read() -> bytes | None` and `write(bytes) -> None`. Return
# None at end of stream: sys.stdin.buffer.read() gives b"" there, which would loop.
reader = NdjsonLineReader() # supply your own if the session keeps reading this stream
result = perform_handshake(io, reader=reader)
if isinstance(result, HandshakeOk):
result.version # the agreed contract major, e.g. "1"
result.pending # frames the peer sent right after its hello — process these first
It is synchronous, where the TypeScript binding is async. Python's standard streams
block and a startup handshake has nothing to overlap with, so async def would drag every
connector into an event loop for nothing; an asyncio caller wraps it with
await asyncio.to_thread(perform_handshake, io).
License
MIT — see LICENSE.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file nimbus_dev_sdk-0.3.0.tar.gz.
File metadata
- Download URL: nimbus_dev_sdk-0.3.0.tar.gz
- Upload date:
- Size: 70.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8e34b7f6ff21c3feaaa20b07733f7dbebc7534bb817ae1d7c86e6336ad2af574
|
|
| MD5 |
9544d828ae9ea7be45c8181edb336205
|
|
| BLAKE2b-256 |
678ac0a97cfa09b7751025dc7b749aeeb99662457b1d21f83e6b2e48112d3871
|
Provenance
The following attestation bundles were made for nimbus_dev_sdk-0.3.0.tar.gz:
Publisher:
release.yml on nimbus-agent/nimbus-sdk
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
nimbus_dev_sdk-0.3.0.tar.gz -
Subject digest:
8e34b7f6ff21c3feaaa20b07733f7dbebc7534bb817ae1d7c86e6336ad2af574 - Sigstore transparency entry: 2300448616
- Sigstore integration time:
-
Permalink:
nimbus-agent/nimbus-sdk@425c364dc75aee93e02b0d6aed1579facf0ddb78 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/nimbus-agent
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@425c364dc75aee93e02b0d6aed1579facf0ddb78 -
Trigger Event:
push
-
Statement type:
File details
Details for the file nimbus_dev_sdk-0.3.0-py3-none-any.whl.
File metadata
- Download URL: nimbus_dev_sdk-0.3.0-py3-none-any.whl
- Upload date:
- Size: 126.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
54660194ad134a4538c5fdb2afdbfe460e24cffd76bc6b683f393eedc51ffc3c
|
|
| MD5 |
b8c355542247c72b2ccabfa0f444ddba
|
|
| BLAKE2b-256 |
acd84b5998ba7af89f43de93a4eba13ec8793c025815c4e0bd4acbf284141d8e
|
Provenance
The following attestation bundles were made for nimbus_dev_sdk-0.3.0-py3-none-any.whl:
Publisher:
release.yml on nimbus-agent/nimbus-sdk
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
nimbus_dev_sdk-0.3.0-py3-none-any.whl -
Subject digest:
54660194ad134a4538c5fdb2afdbfe460e24cffd76bc6b683f393eedc51ffc3c - Sigstore transparency entry: 2300448707
- Sigstore integration time:
-
Permalink:
nimbus-agent/nimbus-sdk@425c364dc75aee93e02b0d6aed1579facf0ddb78 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/nimbus-agent
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@425c364dc75aee93e02b0d6aed1579facf0ddb78 -
Trigger Event:
push
-
Statement type:
