Skip to main content
Change of provenance

The repository or configuration that created this release differ from a previous release. View details.

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

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

Change of provenance

The repository or configuration that created these release files differ from that of a previous release.

We recommend inspecting the repository and configuration before proceeding. View details.

Source distribution (sdist)

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

Built distributions (wheels)

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

Total release size: 25.2 MB

Release files / felix_client-0.6.0rc2.tar.gz

Change of provenance

This file belongs to a release with changed provenance: the repository or configuration that created the release files differ from that of a previous release.

We recommend inspecting the repository and configuration before proceeding. View details.

Download URL felix_client-0.6.0rc2.tar.gz
Size 388.3 kB
Tags Source
SHA-256 checksum
How to use checksums
4ece7e24b5c6bf233662d85ed9a25017391d18e084403660c28e6a663e0c667d
BLAKE2b-256 checksum
How to use checksums
3466d415f94d29f82e88c4942dfbc71e170d86ac3b51831fe31c2f7855c77850
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 4, 2026.

Transparency log

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

Change of provenance

This file belongs to a release with changed provenance: the repository or configuration that created the release files differ from that of a previous release.

We recommend inspecting the repository and configuration before proceeding. View details.

Download URL felix_client-0.6.0rc2-cp39-abi3-win_amd64.whl
Size 4.7 MB
Tags CPython 3.9 Windows x86-64 abi3
SHA-256 checksum
How to use checksums
f11f3815d2ffacedbdf8331f101b266624613674b6854a2eec902d57f7dcdbf8
BLAKE2b-256 checksum
How to use checksums
fe3544991afd5984720ca3694d7e1d56b80c120ef0410eb5a2f33d43912bbad7
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 4, 2026.

Transparency log

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

Change of provenance

This file belongs to a release with changed provenance: the repository or configuration that created the release files differ from that of a previous release.

We recommend inspecting the repository and configuration before proceeding. View details.

Download URL felix_client-0.6.0rc2-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Size 5.1 MB
Tags CPython 3.9 Linux glibc 2.17+ x86-64 abi3
SHA-256 checksum
How to use checksums
c2c7a6609ac7536224d3fe6f74dc8f80dac9d4056ee685f9514f789e03ed1aa2
BLAKE2b-256 checksum
How to use checksums
e5a9f4e7822f331ef63e385d7aef057a772d860f532f604f76e39eb05e619208
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 4, 2026.

Transparency log

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

Change of provenance

This file belongs to a release with changed provenance: the repository or configuration that created the release files differ from that of a previous release.

We recommend inspecting the repository and configuration before proceeding. View details.

Download URL felix_client-0.6.0rc2-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Size 5.3 MB
Tags CPython 3.9 Linux glibc 2.17+ ARM64 abi3
SHA-256 checksum
How to use checksums
77f147cb0a666363b06fd6d571c0d4952bc253119f75c619ae9494f3d1bbde38
BLAKE2b-256 checksum
How to use checksums
f8b819c73b2d766c70aefcfbca7798043b8bc40d8a70427befc111da2c716197
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 4, 2026.

Transparency log

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

Change of provenance

This file belongs to a release with changed provenance: the repository or configuration that created the release files differ from that of a previous release.

We recommend inspecting the repository and configuration before proceeding. View details.

Download URL felix_client-0.6.0rc2-cp39-abi3-macosx_11_0_arm64.whl
Size 4.7 MB
Tags CPython 3.9 abi3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
87852ccb16e1d685794303a69ecd3bd344f9dc339d3a90b9a27e4e03efbf5933
BLAKE2b-256 checksum
How to use checksums
472cb078a95acfa3c62372e320f08516ce5a361bc6113a72a201f4afc4f09820
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 4, 2026.

Transparency log

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

Change of provenance

This file belongs to a release with changed provenance: the repository or configuration that created the release files differ from that of a previous release.

We recommend inspecting the repository and configuration before proceeding. View details.

Download URL felix_client-0.6.0rc2-cp39-abi3-macosx_10_12_x86_64.whl
Size 4.9 MB
Tags CPython 3.9 abi3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
d8acc194ae0da6d0af2be7a95f78630f30a45d938ab14b063228fd83a31e8060
BLAKE2b-256 checksum
How to use checksums
4c3c5ef13550be5056c15876bfb252731599ce35263a08cd1b9cb391a7be2a9a
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 4, 2026.

Transparency log

Security for felix-client 0.6.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.

Change of provenance

The repository and configuration that created this release differ from a previous release.

While this could reflect a routine change by the project maintainers, it may also indicate that the release files have been compromised.

Repository

Select from 6 files

Attestation for felix_client-0.6.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 Oct 4, 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