felix-client 0.5.0__tar.gz

felix_client-0.5.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

felix_client-0.5.0/PKG-INFO

@@ -0,0 +1,127 @@
+Metadata-Version: 2.4
+Name: felix-client
+Version: 0.5.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Rust
+Classifier: Topic :: Database
+Classifier: Topic :: System :: Distributed Computing
+Classifier: Topic :: System :: Networking
+Classifier: Typing :: Typed
+Requires-Dist: pytest>=8 ; extra == 'test'
+Provides-Extra: test
+License-File: LICENSE
+Summary: Python client for Felix — streams, queues, and cache over QUIC
+Keywords: felix,quic,pubsub,streaming,cache
+Home-Page: https://github.com/gabloe/felix
+Author: Gabriel Loewen
+License: Apache-2.0
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Changelog, https://github.com/gabloe/felix/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://gabloe.github.io/felix/clients/python/
+Project-URL: Homepage, https://gabloe.github.io/felix/
+Project-URL: Issues, https://github.com/gabloe/felix/issues
+Project-URL: Repository, https://github.com/gabloe/felix
+
+# 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.
+
+## Two surfaces
+
+Synchronous, for threads and `asyncio.to_thread`:
+
+```python
+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:
+
+```python
+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.
+
+## Beyond publish and subscribe
+
+Both surfaces also cover consumer groups (`group_poll` and the four settles),
+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.
+
+The [clients page](../../docs-site/src/content/docs/api/clients.md) 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:
+
+```python
+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
+
+```bash
+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/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.
+

felix_client-0.5.0/README.md

@@ -0,0 +1,89 @@
+# 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.
+
+## Two surfaces
+
+Synchronous, for threads and `asyncio.to_thread`:
+
+```python
+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:
+
+```python
+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.
+
+## Beyond publish and subscribe
+
+Both surfaces also cover consumer groups (`group_poll` and the four settles),
+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.
+
+The [clients page](../../docs-site/src/content/docs/api/clients.md) 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:
+
+```python
+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
+
+```bash
+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/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.

felix_client-0.5.0/felix-client/Cargo.toml

@@ -0,0 +1,62 @@
+[package]
+name = "felix-client"
+version = "0.5.0"
+edition = "2024"
+license = "Apache-2.0"
+rust-version = "1.97.0"
+description = "Rust client SDK for the Felix pub/sub and cache broker"
+repository = "https://github.com/gabloe/felix"
+homepage = "https://github.com/gabloe/felix"
+readme = "README.md"
+keywords = ["felix", "client", "pubsub", "messaging", "quic"]
+categories = ["network-programming", "api-bindings"]
+
+[dependencies]
+thiserror = "^2"
+anyhow = "^1"
+bytes = "^1"
+ahash = "^0.8"
+hashbrown = { version = "^0.17", features = ["equivalent"] }
+tokio = { version = "^1", features = ["rt-multi-thread", "macros", "net", "time", "sync", "signal", "test-util"] }
+tracing = "^0.1"
+metrics = "^0.24"
+serde = { version = "^1", features = ["derive"] }
+serde_yaml_ng = "^0.10"
+# felix-broker/felix-storage are optional: they're only needed by the `in-process` feature
+# (an embedded-broker convenience mode for local dev/tests). Both are AGPL-3.0 licensed,
+# unlike the rest of this crate's dependency graph (Apache-2.0) — keeping them optional and
+# off by default means the default felix-client build has zero AGPL-3.0 transitive
+# dependencies. See LICENSING.md at the repo root.
+felix-broker = { path = "../felix-broker", version = "0.5.0", optional = true }
+felix-storage = { path = "../felix-storage", version = "0.5.0", optional = true }
+felix-transport = { path = "../felix-transport", version = "0.5.0" }
+felix-wire = { path = "../felix-wire", version = "0.5.0" }
+quinn = "^0.11"
+
+[features]
+default = []
+telemetry = []
+# Embedded-broker convenience mode for local dev/tests, without a real QUIC connection.
+# Off by default — see the dependency comment above.
+in-process = ["dep:felix-broker", "dep:felix-storage"]
+
+[dev-dependencies]
+rcgen = "^0.14"
+rustls = "^0.23"
+serial_test = "^4"
+tempfile = "^3"
+tracing-subscriber = { version = "^0.3", features = ["env-filter"] }
+
+[package.metadata.docs.rs]
+# `in-process` and `telemetry` are off by default; document them anyway.
+all-features = true
+
+[lints.rust]
+# `pub` that is not actually reachable from outside the crate reads as public
+# API and makes the real surface hard to see. Use `pub(crate)`.
+unreachable_pub = "warn"
+
+[lints.clippy]
+# One module style: `foo.rs` + `foo/`, never `foo/mod.rs`. `task lint` runs
+# clippy with -D warnings, so this fails CI on a new mod.rs.
+mod_module_files = "warn"