aiotruenas

Asyncio-native Python client for the TrueNAS JSON-RPC 2.0 WebSocket API (ws(s)://<host>/api/current, TrueNAS 25.04+).

No dependency on Home Assistant or any other framework — usable as a standalone library.

Installation

pip install .

Usage

import asyncio

from aiotruenas import TrueNASClient


async def main() -> None:
    async with TrueNASClient("truenas.local", "1-abcdef...") as client:
        info = await client.call("system.info")
        print(info)

        sub_id, _ = await client.subscribe("app.stats")
        try:
            events = await client.get_subscription_events(sub_id, event_timeout=5.0)
            print(events)
        finally:
            await client.unsubscribe(sub_id)


asyncio.run(main())

call() is a generic RPC surface — pass any TrueNAS JSON-RPC method name and its params (list or dict). Long-running operations that return a job id (scrub, replication, dataset lock/unlock, ...) can be polled automatically with job=True:

await client.call("pool.scrub.scrub", ["tank", "START"], job=True)

Connection and protocol failures are raised as typed exceptions (see aiotruenas.exceptions) rather than returned as an error code/string, so callers can except TrueNASAuthenticationError, except TrueNASConnectionError, etc.

Status

Early development (v1: generic call surface only, no typed per-domain convenience methods yet). See PROMPT.md for the full design brief and CLAUDE.md for repo guidance.

License

Apache-2.0, see LICENSE.

Download files

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

Source Distribution

aiotruenas-1.2.0.tar.gz (26.8 kB view details)

Uploaded Aug 23, 2026 Source

Built Distribution

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

aiotruenas-1.2.0-py3-none-any.whl (17.7 kB view details)

Uploaded Aug 23, 2026 Python 3

File details

Details for the file aiotruenas-1.2.0.tar.gz.

File metadata

Download URL: aiotruenas-1.2.0.tar.gz
Upload date: Aug 23, 2026
Size: 26.8 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for aiotruenas-1.2.0.tar.gz
Algorithm	Hash digest
SHA256	`2bb25024478399417f18f1a8c0e26271b3d872c0925d9a12c8970c74ae958c8e`
MD5	`7a7b1ba9c3611597e4c87ae503c173d7`
BLAKE2b-256	`d31b68441b01d53240a47538f3af255961c3a08865d880a4bfeef7e187e35db4`

See more details on using hashes here.

Provenance

The following attestation bundles were made for aiotruenas-1.2.0.tar.gz:

Publisher: pypi.yaml on kayl-codes/aiotruenas

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

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: aiotruenas-1.2.0.tar.gz
- Subject digest: 2bb25024478399417f18f1a8c0e26271b3d872c0925d9a12c8970c74ae958c8e
- Sigstore transparency entry: 2578253050
- Sigstore integration time: Aug 23, 2026
Source repository:
- Permalink: kayl-codes/aiotruenas@658596f5b7f60d98904eb986d7cf2a7c8db13522
- Branch / Tag: refs/tags/v1.2.0
- Owner: https://github.com/kayl-codes
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: pypi.yaml@658596f5b7f60d98904eb986d7cf2a7c8db13522
- Trigger Event: release