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

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

Built distributions (wheels)

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

Total release size: 27.1 MB

Release files / felix_client-0.6.0rc7.tar.gz

Download URL felix_client-0.6.0rc7.tar.gz
Size 438.6 kB
Tags Source
SHA-256 checksum
How to use checksums
7363c2c4715a9f9ab3775586d45fb0da7ccdd080e7c655979d70518a2f9a5da3
BLAKE2b-256 checksum
How to use checksums
7bb1e4ee78f7731b07ddc74f822a65e7e22a2fdcef25e498f0b8f2499c757295
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 12, 2026.

Transparency log

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

Download URL felix_client-0.6.0rc7-cp39-abi3-win_amd64.whl
Size 5.1 MB
Tags CPython 3.9 Windows x86-64 abi3
SHA-256 checksum
How to use checksums
18ca29b1ca26428cb5d1c4fc8babe3ec20181fda8e916ec1c95c8f8430147ce0
BLAKE2b-256 checksum
How to use checksums
54ab125cb324b43027f1ffb266ef17b8a080062698fb3bde3fbbd4dbf174d33f
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 12, 2026.

Transparency log

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

Download URL felix_client-0.6.0rc7-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Size 5.5 MB
Tags CPython 3.9 Linux glibc 2.17+ x86-64 abi3
SHA-256 checksum
How to use checksums
955d7df9259a9670bd6336ae8308650b93a94e650064bc57151edcc253495063
BLAKE2b-256 checksum
How to use checksums
b140e3087f6a22fc4e87ffe6ecb04a2eb6885536b02549ee0c2535c9498c78a3
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 12, 2026.

Transparency log

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

Download URL felix_client-0.6.0rc7-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Size 5.7 MB
Tags CPython 3.9 Linux glibc 2.17+ ARM64 abi3
SHA-256 checksum
How to use checksums
8abf7a3c4d2219c9f2ec3d33889611a9aa5df6fa793d06f1a61d981aa71af444
BLAKE2b-256 checksum
How to use checksums
2793d25f14f822f6deb73324669c17309fb506bedbc4a0636fb00a1e7b0435a7
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 12, 2026.

Transparency log

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

Download URL felix_client-0.6.0rc7-cp39-abi3-macosx_11_0_arm64.whl
Size 5.1 MB
Tags CPython 3.9 abi3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
00e74706f224ed44f8bad34930e2c8749953ece5eac4fbfcf3aeecd056738545
BLAKE2b-256 checksum
How to use checksums
7a0c4f97945c7467a1cc2e5dcef2a17d97f02b24061adc966c61d36c4aa609b2
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 12, 2026.

Transparency log

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

Download URL felix_client-0.6.0rc7-cp39-abi3-macosx_10_12_x86_64.whl
Size 5.3 MB
Tags CPython 3.9 abi3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
4c7c444b0a46cea61c2fe4377b9be9681356d3681fc882a302c8bfb54330e266
BLAKE2b-256 checksum
How to use checksums
63d0056e7e8416ff5992b6e46f26fc11d983d89248d1e699e287e9ee42a07eda
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 12, 2026.

Transparency log

Security for felix-client 0.6.0rc7

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.0rc7.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 12, 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