Skip to main content

aegisdb — Python client

The client for AegisDB's newline-delimited JSON protocol. No dependencies — AegisDB is a single dependency-free binary and its wire protocol is one JSON object per line over TCP, so the client that talks to it has no business dragging in a tree.

pip install aegisdb
from aegisdb import AegisClient, NotFound

with AegisClient(host="127.0.0.1", port=9470, token="…") as db:
    rec = db.insert("prefers dark mode", type="semantic", tags=["user"])
    print(db.search(query="dark mode", top_k=5)["records"])
    try:
        db.get(999)
    except NotFound as exc:
        print(exc.code, exc.message)

Every wire operation has a method — insert / insert_many, get, history, update, delete, search, count, consolidate, forget, export, purge, promote, relate, traverse, conflicts, ping, stats, snapshot, and the token admin trio. Each accepts only the fields the server actually reads (the list was taken from the dispatcher, not from prose), plus **extra as the escape hatch for a field a newer server understands.

What it does that a bare socket doesn't

Errors are exceptions, one class per wire code. NotFound, Forbidden, NotReady, RateLimited, MemoryLimit, and the rest — all under AegisRequestError, which carries .code and .message verbatim so a code this client predates still arrives catchable rather than as a string you compare by hand. AegisUnavailable is deliberately not one of them: a refusal means the server did not act, while an unanswered request says nothing either way, and that difference is what you reason about when deciding whether to retry.

One connection, reused. The server supports pipelining and this client deliberately does not use it: one line out, one line back, so a response is never mistaken for the tail of another. A reused connection that fails with no response received is retried once on a fresh one, because the server reaps connections idle past --idle-timeout-sec and that is exactly what a pause between calls looks like.

That retry is safe for the case it exists for — a reaped connection never delivered the request. It is not safe in general: if the server received the request and the answer was lost, a retried insert writes a second record. Pass retry_stale=False where that matters more than the convenience, or reuse=False for a fresh connection per request.

Not thread-safe. A client owns one socket. Use one per thread, or reuse=False.

An unspecified argument is omitted, not defaulted. None means "not specified", so the server's default applies rather than a copy of it kept here — two copies drift, and the client's would silently win. Falsy values are not treated as absent: limit=0 is the conflicts count-without-listing probe, and subsume=False means something.

agent_id does not scope everything

AegisClient(agent_id="…") is applied to every request that does not name its own, mirroring how the server scopes reads and writes. But consolidate, forget, update, delete, relate and promote are scoped by the token's namespace and ignore agent_id entirely — so with authentication off they act across the whole server whatever you set it to. That asymmetry is the server's, not this client's; the affected methods say so in their docstrings.

Version

Published from the same git tag as the server and the Claude Code integration, so aegisdb, aegisdb-mcp and the server binary all carry the same version.

Tests

python3 -m unittest discover -s tests            # from clients/python/
make sdk-test                                    # from the repo root

test_protocol.py runs against a fake server and needs nothing. test_live.py exercises every method against a real build/aegisdb and skips when it is not built — which is the point: the server ignores request fields it does not recognise, so a misspelled field name here would otherwise succeed and quietly do the wrong thing. It has already earned its keep, catching token_revoke coercing a string fingerprint to an int.

Download files

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

Source Distribution

aegisdb-0.8.3.tar.gz (21.5 kB view details)

Uploaded Source

Built Distribution

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

aegisdb-0.8.3-py3-none-any.whl (13.2 kB view details)

Uploaded Python 3

File details

Details for the file aegisdb-0.8.3.tar.gz.

File metadata

  • Download URL: aegisdb-0.8.3.tar.gz
  • Upload date:
  • Size: 21.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for aegisdb-0.8.3.tar.gz
Algorithm Hash digest
SHA256 0566fca8ed63a1b351a120f6f5137b9723871cc7ed44c0ea3443a432fbcd214e
MD5 88484f5e678bbad45d466212b7632143
BLAKE2b-256 c31dbeea7b7ab4ff5657c58cef7b6007202bc225b4c3b4331dc5c544cf0bee18

See more details on using hashes here.

Provenance

The following attestation bundles were made for aegisdb-0.8.3.tar.gz:

Publisher: pypi.yml on d4n-larsson/aegisdb

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file aegisdb-0.8.3-py3-none-any.whl.

File metadata

  • Download URL: aegisdb-0.8.3-py3-none-any.whl
  • Upload date:
  • Size: 13.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for aegisdb-0.8.3-py3-none-any.whl
Algorithm Hash digest
SHA256 90dd7385ce581382f622d87019a0f23d53aa46aa6fffb6dcb6201ace01c611e6
MD5 b75e297acdc8cc6cb1c255ff5bfcd800
BLAKE2b-256 c293dfb05dba43781b9e48d2646c8535639a2199f9ec6048f3bffde1ce583aa1

See more details on using hashes here.

Provenance

The following attestation bundles were made for aegisdb-0.8.3-py3-none-any.whl:

Publisher: pypi.yml on d4n-larsson/aegisdb

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.9.1

2 files

0.9.0

2 files

This release

0.8.3 This release

2 files

0.8.2

2 files

0.8.1

2 files

0.8.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page