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://gabloe.github.io/felix/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.0rc0

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.0rc0
File Size Uploaded Provenance Actions
felix_client-0.6.0rc0.tar.gz 359.0 kB With provenance Details for felix_client-0.6.0rc0.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for felix-client 0.6.0rc0
File Actions
felix_client-0.6.0rc0-cp39-abi3-win_amd64.whl CPython 3.9 abi3 Windows x86-64 Details for felix_client-0.6.0rc0-cp39-abi3-win_amd64.whl
felix_client-0.6.0rc0-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.0rc0-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
felix_client-0.6.0rc0-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl CPython 3.9 abi3 Linux glibc 2.17+ ARM64 Details for felix_client-0.6.0rc0-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
felix_client-0.6.0rc0-cp39-abi3-macosx_11_0_arm64.whl CPython 3.9 abi3 macOS 11.0+ ARM64 Details for felix_client-0.6.0rc0-cp39-abi3-macosx_11_0_arm64.whl
felix_client-0.6.0rc0-cp39-abi3-macosx_10_12_x86_64.whl CPython 3.9 abi3 macOS 10.12+ x86-64 Details for felix_client-0.6.0rc0-cp39-abi3-macosx_10_12_x86_64.whl

Total release size: 24.0 MB

Release files / felix_client-0.6.0rc0.tar.gz

Download URL felix_client-0.6.0rc0.tar.gz
Size 359.0 kB
Tags Source
SHA-256 checksum
How to use checksums
a5be095a29c493e1008cecdb9f91dc20a8d0d5864dfa6301a2ad6d60c2859f4c
BLAKE2b-256 checksum
How to use checksums
35c9ccd95cd470ec3e4ec478094304f0c0e6ddb632e24419b69281c34d332016
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 2, 2026.

Transparency log

Release files / felix_client-0.6.0rc0-cp39-abi3-win_amd64.whl

Download URL felix_client-0.6.0rc0-cp39-abi3-win_amd64.whl
Size 4.5 MB
Tags CPython 3.9 Windows x86-64 abi3
SHA-256 checksum
How to use checksums
dc63e8a89b3e7f43be1ece07b1cdf67364f7397c00823ff4b6ddc2c6e718b032
BLAKE2b-256 checksum
How to use checksums
49ef24f2bc79189b252aee2cfd95e7e6db4c943b8fd49a668d9af16479d27a0f
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 2, 2026.

Transparency log

Release files / felix_client-0.6.0rc0-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

Download URL felix_client-0.6.0rc0-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Size 4.9 MB
Tags CPython 3.9 Linux glibc 2.17+ x86-64 abi3
SHA-256 checksum
How to use checksums
ce82f9a416d5baee048bf9d015377ac325bd783befa44f884ca220d1443a68c0
BLAKE2b-256 checksum
How to use checksums
3f5320ce636b3d67686282c73dfbc6a9bee0facba3dc5c3d7bd28baf7f61a736
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 2, 2026.

Transparency log

Release files / felix_client-0.6.0rc0-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl

Download URL felix_client-0.6.0rc0-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Size 5.1 MB
Tags CPython 3.9 Linux glibc 2.17+ ARM64 abi3
SHA-256 checksum
How to use checksums
5cbbe7e23be0e6f4672043a373e2cfa2912530ebf31751b7e15be161d9ed48e3
BLAKE2b-256 checksum
How to use checksums
3fd279f281015fa84971c22f94c70a0f7fd063e9c24c9211f4bd1eb2630c4517
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 2, 2026.

Transparency log

Release files / felix_client-0.6.0rc0-cp39-abi3-macosx_11_0_arm64.whl

Download URL felix_client-0.6.0rc0-cp39-abi3-macosx_11_0_arm64.whl
Size 4.5 MB
Tags CPython 3.9 abi3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
f34b09d0801e80ef1352d6438cd8dd009128067684b3bab551b21981e04ffd6e
BLAKE2b-256 checksum
How to use checksums
a10ac628495e1a5b1de03e5116f4cb63c1dab55092ded03b5f857c31902c8b86
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 2, 2026.

Transparency log

Release files / felix_client-0.6.0rc0-cp39-abi3-macosx_10_12_x86_64.whl

Download URL felix_client-0.6.0rc0-cp39-abi3-macosx_10_12_x86_64.whl
Size 4.7 MB
Tags CPython 3.9 abi3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
fafe994bd9040ce57f5de99770e3870dd83be5a5c9087a6db628c99c7f53d34c
BLAKE2b-256 checksum
How to use checksums
946208e33ce27c46b2dde22068d3ee91cbbf0a422880f9c801e112a54ac1bc2a
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 2, 2026.

Transparency log

Security for felix-client 0.6.0rc0

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.0rc0.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 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