Skip to main content

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 and the four settles, sent to the shard's leader by following the broker's redirect), cache watches (watch_cache, including retained watches that hand you current state before live changes), and multi-shard subscriptions (subscribe_sharded, which opens one subscription per shard and merges them). 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.
  • A prefix watch reads one shard. Keys sharing a prefix do not share a shard, so watching a whole multi-shard cache means one watch per shard.

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.

The clients page has the worked examples.

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.

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.6.1

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.6.1
File Size Uploaded Provenance Actions
felix_client-0.6.1.tar.gz 494.9 kB With provenance Details for felix_client-0.6.1.tar.gz

Built distributions (wheels)

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

Total release size: 29.0 MB

Release files / felix_client-0.6.1.tar.gz

Download URL felix_client-0.6.1.tar.gz
Size 494.9 kB
Tags Source
SHA-256 checksum
How to use checksums
e2a06b991be1d24716adf826e2c680d47f9ec8f2cd9b77dd9a1181d27d579d8d
BLAKE2b-256 checksum
How to use checksums
eae441c2f1b8c4870e9dcdee0928dab7b4a9e000bee7d1066a3493aca3365df3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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 Oct 24, 2026.

Transparency log

Release files / felix_client-0.6.1-cp39-abi3-win_amd64.whl

Download URL felix_client-0.6.1-cp39-abi3-win_amd64.whl
Size 5.5 MB
Tags CPython 3.9 Windows x86-64 abi3
SHA-256 checksum
How to use checksums
48a1c76db7d3ee4c63849395e45712e69737c6a938a3ce27e986bfb71e4cf90e
BLAKE2b-256 checksum
How to use checksums
a89d2491a65b98d227d6630c79e836c4f9b9622e7dc70bd19ce1b7e7d573f7ae
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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 Oct 24, 2026.

Transparency log

Release files / felix_client-0.6.1-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

Download URL felix_client-0.6.1-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Size 5.9 MB
Tags CPython 3.9 Linux glibc 2.17+ x86-64 abi3
SHA-256 checksum
How to use checksums
319b12d9cfd1531096f42be40134b7b429695808ce60eda673c4dc9faf6c0acc
BLAKE2b-256 checksum
How to use checksums
bf55c7bd8e209b5cf5164ef23137ad519d0b00199957c56b84c53d7d81320cb1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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 Oct 24, 2026.

Transparency log

Release files / felix_client-0.6.1-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl

Download URL felix_client-0.6.1-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Size 6.1 MB
Tags CPython 3.9 Linux glibc 2.17+ ARM64 abi3
SHA-256 checksum
How to use checksums
d4e0259db1959b9040d46facaa57630ec5191db12011106599b924f8543d6585
BLAKE2b-256 checksum
How to use checksums
cb9b8000b0a7509f40f4ef9d8c716212c9b73450a80223aef7c51e0367253b7f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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 Oct 24, 2026.

Transparency log

Release files / felix_client-0.6.1-cp39-abi3-macosx_11_0_arm64.whl

Download URL felix_client-0.6.1-cp39-abi3-macosx_11_0_arm64.whl
Size 5.4 MB
Tags CPython 3.9 abi3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
3a139af030b13cd84f35f2d36566d4cffa4ef6d60ee233af97c429072413d4c1
BLAKE2b-256 checksum
How to use checksums
a86ad19f6cde15456f3ffa31f35723ad018e39e73d505bdda76dbb554772bc6d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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 Oct 24, 2026.

Transparency log

Release files / felix_client-0.6.1-cp39-abi3-macosx_10_12_x86_64.whl

Download URL felix_client-0.6.1-cp39-abi3-macosx_10_12_x86_64.whl
Size 5.6 MB
Tags CPython 3.9 abi3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
78b9e593f27b9731c53ce088807869f8521c4c40fcbec91a70c455225173ab33
BLAKE2b-256 checksum
How to use checksums
c10f31f5b2100050ff842470fc2f8b41ef95bc5e407d755af9ff8383bf731f10
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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 Oct 24, 2026.

Transparency log

Security for felix-client 0.6.1

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.6.1.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 Oct 24, 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