Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

felix-client for Python

Python bindings for Felix, built as a wrapper over the Rust client rather than a reimplementation of the protocol.

That distinction is the point. Reconnection, redirect-following, retry classification and offset bookkeeping are hard to get right and expensive to get wrong — a second implementation is a second set of subtle bugs in exactly the places that matter. Here they exist once, in felix-client, and every language binds to them.

pip install felix-client

Wheels ship compiled, one per platform, covering every Python from 3.9 up — so installing needs no Rust toolchain. Linux (x86-64 and arm64), macOS (Intel and Apple silicon) and Windows x86-64 are covered; anything else builds from the sdist and does need one.

Full documentation: https://docs.getfelix.dev/clients/python/

Two surfaces

Synchronous, for threads and asyncio.to_thread:

import felix

with felix.Client("127.0.0.1:5000", tenant_id="t1", token=tok, ca_file=ca) as client:
    client.publish("t1", "default", "events", b"hello")
    with client.subscribe("t1", "default", "events") as events:
        for event in events:
            print(event.payload, event.offset)

Asynchronous, which is what most Python realtime backends want:

client = await felix.AsyncClient.connect(addr, tenant_id="t1", token=tok, ca_file=ca)
async with client:
    await client.publish("t1", "default", "events", b"hello")
    async with await client.subscribe("t1", "default", "events") as events:
        async for event in events:
            print(event.payload, event.offset)

Both wrap the same client and fail over identically. The sync one blocks with the GIL released; the async one yields to your event loop.

publish returns the record's log offset once the broker has written it, and None when it acknowledged earlier than that (ack="none", or a broker that acks on enqueue), the stream has no log, or the broker is too old to say.

Beyond publish and subscribe

Both surfaces also cover consumer groups (group_poll, the settles including group_nack_after and group_dead_letter, group_extend, and group_create, group_seek, group_describe and group_delete, each with a *_stream form for every shard, sent to the shard's leader by following the broker's redirect; group_sharded polls every shard through one handle), cache watches (watch_cache, including retained watches that hand you current state before live changes, and watch_cache_sharded, which merges a prefix across every shard), and multi-shard subscriptions (subscribe_sharded, which opens one subscription per shard and merges them; subscribe(shard=) reads one named shard). offset_for_time finds the offset a time begins at, and read returns a page of committed records without subscribing. publish_batch and publish_records send ordered batches; the latter splits keyed records by shard and returns a BatchReport saying which pieces landed. Two things catch people out, so they are worth saying here:

  • Publishing without a key= puts every record on shard 0. The key is what spreads a stream, and a multi-shard stream published without one behaves exactly like a single-shard one.
  • watch_cache with a prefix reads one shard. Keys sharing a prefix do not share a shard, so watching a whole multi-shard cache means watch_cache_sharded.

Both surfaces also have atomic commits: commit(tenant_id, namespace, entity_key, [CommitOp.publish(...) or CommitOp.enqueue(...), CommitOp.put(...), CommitOp.delete(...)]) writes an event and its state changes as one record and returns a CommitReceipt with the offset, and state_get reads the state back with that offset as its version. A commit naming a second stream raises NotOnOwningShardError, and one without exactly one event raises EventCountError, before anything is sent. See atomic commits for what atomic covers.

trim_before(tenant_id, namespace, stream, shard, before, expected_offset, headers=None) hides a durable shard's oldest records, only if the shard's next offset is expected_offset, and returns a ConditionalTrim. A broker without head trims raises TrimError.

The clients page has the worked examples.

Tokens that expire

A token lasts 15 minutes by default, and a client that outlives one passes token_provider, a function that returns a fresh token. The client calls it lazily, one call at a time, when a stream is about to authenticate and the held token is missing, past two thirds of its life, or was refused. Client takes a plain function or an async def; AsyncClient takes an async def. token= is then optional. See Getting and refreshing a token.

felix.Client(addr, tenant_id="t1", token_provider=fetch_token, ca_file=ca)

TLS

QUIC has no unencrypted mode, so there is always a trust decision — and deliberately no "skip verification" switch, because that is the setting that silently turns a secure deployment insecure. Either the platform trust store (the default) or an explicit CA:

felix.Client(addr, tenant_id=..., token=..., ca_file="/path/to/ca.pem")

A development broker generates a self-signed certificate at startup; set FELIX_TLS_CERT_EXPORT=/path/ca.pem on the broker and point ca_file at it.

Building

pip install maturin
task python:develop      # build and install into the active virtualenv
task python:check        # fmt, clippy, build

This crate is deliberately outside the Cargo workspace — an extension module carries pyo3/extension-module, which cannot be linked into a test binary — so task python:check is what builds it, not task test.

What is not wrapped

The Rust client has more than this binding wraps. What is left out, and why:

  • Subscription counters. ClusterSubscription::moves, reconnects and stream_deleted have no accessor on a subscription, sharded or not. A read in flight holds the handle, so these need their own shared state. A follow-up is planned; a move still shows up as a ShardMoved item on a sharded subscription. A cache watch does expose moves, reconnects, error and resume_from.
  • The single-connection Connection and Publisher layer (topology, stream_routing, shard_owners, inspect_shard, supports_*, publish_batch_binary*, connect_with_transport). The binding wraps Client, which owns those connections and runs the feature checks itself.
  • hand_off_* and Handed on the idempotent producer. They hand back raw futures; publish_batches is the iterator-shaped equivalent.
  • ClientConfig options such as publishers and timestamps. They are connection configuration, set once, not calls.

Conformance

The semantics a Felix client must implement are catalogued in crates/testing/felix-conformance/scenarios.toml, with task conformance:scenarios to read them and task conformance:verify to check a client's results. That catalogue — not this README — is the contract, and it is what the next language's client is gated on.

Metadata

Release files for felix-client 0.7.0rc2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for felix-client 0.7.0rc2
File Size Uploaded Provenance Actions
felix_client-0.7.0rc2.tar.gz 626.6 kB With provenance Details for felix_client-0.7.0rc2.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for felix-client 0.7.0rc2
File Actions
felix_client-0.7.0rc2-cp39-abi3-win_amd64.whl CPython 3.9 abi3 Windows x86-64 Details for felix_client-0.7.0rc2-cp39-abi3-win_amd64.whl
felix_client-0.7.0rc2-cp39-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl CPython 3.9 abi3 Linux glibc 2.17+ x86-64 Details for felix_client-0.7.0rc2-cp39-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
felix_client-0.7.0rc2-cp39-abi3-manylinux2014_aarch64.manylinux_2_17_aarch64.whl CPython 3.9 abi3 Linux glibc 2.17+ ARM64 Details for felix_client-0.7.0rc2-cp39-abi3-manylinux2014_aarch64.manylinux_2_17_aarch64.whl
felix_client-0.7.0rc2-cp39-abi3-macosx_11_0_arm64.whl CPython 3.9 abi3 macOS 11.0+ ARM64 Details for felix_client-0.7.0rc2-cp39-abi3-macosx_11_0_arm64.whl
felix_client-0.7.0rc2-cp39-abi3-macosx_10_12_x86_64.whl CPython 3.9 abi3 macOS 10.12+ x86-64 Details for felix_client-0.7.0rc2-cp39-abi3-macosx_10_12_x86_64.whl

Total release size: 43.7 MB

Release files / felix_client-0.7.0rc2.tar.gz

Download URL felix_client-0.7.0rc2.tar.gz
Size 626.6 kB
Tags Source
SHA-256 checksum
How to use checksums
556dbe67cace2d0490c6dadd436ae23fbf7f97df167ad59ddeba85d8bf5c138b
BLAKE2b-256 checksum
How to use checksums
812c45379d10752a7bcdc1c2b770d3c2a174b414019a8788a5dc5e84c26a9e81
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 2, 2026.

Transparency log

Release files / felix_client-0.7.0rc2-cp39-abi3-win_amd64.whl

Download URL felix_client-0.7.0rc2-cp39-abi3-win_amd64.whl
Size 8.8 MB
Tags CPython 3.9 Windows x86-64 abi3
SHA-256 checksum
How to use checksums
386f77de2403746446cd9f804c30374e305a2db85d5e86a63c1ea039a2326c59
BLAKE2b-256 checksum
How to use checksums
07d52c7141053c8008ceefba4e75e3178be5bcdea0bcf0c5492e6a1f73767a8f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 2, 2026.

Transparency log

Release files / felix_client-0.7.0rc2-cp39-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl

Download URL felix_client-0.7.0rc2-cp39-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
Size 8.8 MB
Tags CPython 3.9 Linux glibc 2.17+ x86-64 abi3
SHA-256 checksum
How to use checksums
d04087bcecef22064a4f7ed89925cf04d5c58a7398687be1b985bc75619e9fb7
BLAKE2b-256 checksum
How to use checksums
9162dc71b60c72c3d007d3819661b48d541e0eb03e33b200da0771c907b7cea3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 2, 2026.

Transparency log

Release files / felix_client-0.7.0rc2-cp39-abi3-manylinux2014_aarch64.manylinux_2_17_aarch64.whl

Download URL felix_client-0.7.0rc2-cp39-abi3-manylinux2014_aarch64.manylinux_2_17_aarch64.whl
Size 9.0 MB
Tags CPython 3.9 Linux glibc 2.17+ ARM64 abi3
SHA-256 checksum
How to use checksums
020566f02db0333c45276044afa7e4d11d583ea80eb2e4ac8fb0bac964349003
BLAKE2b-256 checksum
How to use checksums
2072594b3248f2da61366b2b6c2f812a489c9534d5234d0780d87f097898a5aa
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 2, 2026.

Transparency log

Release files / felix_client-0.7.0rc2-cp39-abi3-macosx_11_0_arm64.whl

Download URL felix_client-0.7.0rc2-cp39-abi3-macosx_11_0_arm64.whl
Size 8.1 MB
Tags CPython 3.9 abi3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
0be57eccbf6f7f356eed50f79f08bcf608c2d3dfa8aa2c02ba151804dfac3967
BLAKE2b-256 checksum
How to use checksums
e1d9a10c35838c527b3ceac089ebba6655c25fb8da73eecee1219ebac208e67c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 2, 2026.

Transparency log

Release files / felix_client-0.7.0rc2-cp39-abi3-macosx_10_12_x86_64.whl

Download URL felix_client-0.7.0rc2-cp39-abi3-macosx_10_12_x86_64.whl
Size 8.4 MB
Tags CPython 3.9 abi3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
b11ed69c978376ae5b87babbe5a2935c5462e52cd2e5faeef6190bb529229eea
BLAKE2b-256 checksum
How to use checksums
a5bf320a3a3ac98969eb95c31ccc5388f37a6fc42cf1e4d2e27ea84ca13ae03d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 2, 2026.

Transparency log

Security for felix-client 0.7.0rc2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 6 files in this release have been uploaded with provenance metadata.

Select from 6 files

Attestation for felix_client-0.7.0rc2.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 2, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page