flagnetic 0.1.0__tar.gz

flagnetic-0.1.0/.gitignore

@@ -0,0 +1,3 @@
+__pycache__/
+.venv/
+dist/

flagnetic-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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.

flagnetic-0.1.0/PKG-INFO

@@ -0,0 +1,164 @@
+Metadata-Version: 2.5
+Name: flagnetic
+Version: 0.1.0
+Summary: Python SDK for Flagnetic, self-hosted feature flags and experiments
+Project-URL: Homepage, https://github.com/azverinus/flagnetic
+Project-URL: Source, https://github.com/azverinus/flagnetic/tree/main/sdks/python
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Provides-Extra: openfeature
+Requires-Dist: openfeature-sdk>=0.9; extra == 'openfeature'
+Description-Content-Type: text/markdown
+
+# flagnetic
+
+Python SDK for [Flagnetic](https://github.com/azverinus/flagnetic), self-hosted feature flags and experiments.
+
+```bash
+pip install flagnetic
+```
+
+It needs Python 3.11 or later and installs no dependency: the package is pure Python, its regular expression engine
+included, so it installs the same on Alpine and on free-threaded builds. Supported: the Python releases still
+supported upstream (a release reaching its end of life is dropped in a minor version) and, with the extra,
+`openfeature-sdk` 0.9 and later. The package speaks the SDK API `/sdk/v1` and works with every Flagnetic server from
+0.1.0 on ([compatibility](../../docs/sdks/compatibility.md)); [docs/sdks/python.md](../../docs/sdks/python.md) is how
+it is deployed and tested.
+
+## Quick start
+
+```python
+import flagnetic
+
+client = flagnetic.Client("<server SDK key>", "https://flags.example.com")
+client.ready(timeout=5)  # fresh, last_good or built_in; never raises
+
+context = flagnetic.Context(units={"user": "u-1001"}, attributes={"plan": "pro"})
+if client.get_bool(context, "new-checkout", False):
+    ...
+
+client.close()
+```
+
+The getters never block and never raise: they read the ruleset the client holds and serve the default you pass when
+they cannot serve the flag. One background thread fetches the ruleset with `If-None-Match`, holds the ruleset stream
+(a kill switch reaches the client within two seconds), polls every 30 seconds while the stream is down, and backs
+off with jitter. `store="/var/lib/app/flagnetic.json"` keeps the last good ruleset across restarts.
+
+## Experiments and events
+
+The same thread reports an evaluation summary every minute (counts per flag, variation and reason, never a unit ID or
+a value) and sends exposures and aliases every two seconds, retrying with the same event IDs so the server drops a
+resend. An evaluation alone is not an exposure: call `exposure` where the unit actually meets the behaviour, or turn
+on automatic exposure for the flag.
+
+```python
+price = client.get_string(context, "pricing", "Built-in price")
+client.exposure(context, "pricing")  # reports the assignment just served
+client.alias("anonymous", "d-8f1c", "user", "u-1001")  # after sign-up
+client.flush(timeout=5)  # close() flushes too
+```
+
+## Pre-forking servers and asyncio
+
+Under gunicorn or uWSGI, build the client before the workers fork, or in each worker: a forked worker restarts the
+thread by itself, refetches and reports its own events. No hook is needed.
+
+The getters never block, so they are safe in a coroutine. Start-up and shutdown wait on a worker thread:
+
+```python
+stage = await client.aready(timeout=5)
+await client.aflush()
+await client.aclose()
+```
+
+## Tests and local overrides
+
+`flagnetic.testing` builds offline clients that make no request and start no thread:
+
+```python
+from flagnetic import testing
+
+client = testing.from_values({"new-checkout": True})  # or from_document(...), from_file(path)
+client.set("new-checkout", False)  # change listeners fire
+client.reload()  # back to what it was built from
+client.recorder.exposures()  # what it would have reported
+```
+
+`Client(..., allow_overrides=True)` enables `client.local_overrides.set(key, value)`, served with reason
+`local_override`; without the option `set` raises `LocalOverridesNotAllowed`, and a protected environment refuses and
+drops every local override.
+
+## OpenFeature
+
+```bash
+pip install 'flagnetic[openfeature]'
+```
+
+The extra installs `openfeature-sdk` 0.9 or later and the provider in `flagnetic.openfeature`. It takes the client's
+arguments and options and builds the client itself:
+
+```python
+from openfeature import api
+from openfeature.evaluation_context import EvaluationContext
+from openfeature.track import TrackingEventDetails
+from flagnetic.openfeature import Provider
+
+provider = Provider("<server SDK key>", "https://flags.example.com", unit_type="user")
+api.set_provider_and_wait(provider)  # api.set_provider before openfeature-sdk 0.10
+client = api.get_client()
+
+context = EvaluationContext("u-1001", {"plan": "pro", "units": {"account": "a-17"}})
+price = client.get_string_value("pricing", "Built-in price", context)
+client.track("exposure", context, TrackingEventDetails().add("flag", "pricing"))
+client.track(
+    "alias",
+    tracking_event_details=TrackingEventDetails()
+    .add("fromUnitType", "anonymous")
+    .add("fromUnitId", "d-8f1c")
+    .add("toUnitType", "user")
+    .add("toUnitId", "u-1001"),
+)
+```
+
+The targeting key is the unit ID of `unit_type`; the `units` attribute adds further units by unit type; every other
+attribute is an attribute of the context. Reasons map as in every Flagnetic provider:
+
+| Flagnetic | OpenFeature |
+|---|---|
+| `rule`, `prerequisite_failed`, `override`, `targeting_match` | `TARGETING_MATCH` |
+| `rollout`, `experiment` | `SPLIT` |
+| `fallthrough` | `DEFAULT` |
+| `off` | `DISABLED` |
+| `local_override` | `STATIC` |
+| `error` | `ERROR` |
+| `fallback` | `ERROR`, with `FLAG_NOT_FOUND`, `TYPE_MISMATCH` or `GENERAL` |
+
+The flag metadata carries the Flagnetic reason as `flagnetic_reason`, with `stage`, `ruleset_version`, `variation`,
+`overridden` and, for an experiment, its `experiment_*` fields. The provider emits `PROVIDER_CONFIGURATION_CHANGED`
+with the changed flag keys, `PROVIDER_STALE` while the client serves its last good ruleset, `PROVIDER_READY` once it
+is fresh again and `PROVIDER_ERROR` when the SDK key is revoked. Initialization waits up to `ready_timeout` seconds
+(default 10) for the first fetch and never fails. `provider.client` is the wrapped client, for local overrides,
+`flush` and the recorder of an offline provider (`Provider("", "", offline=document)`).
+
+## Development
+
+```bash
+uv sync --extra openfeature
+uv run ruff check . && uv run ruff format --check . && uv run mypy
+uv run pytest
+uv run pytest e2e  # the smoke against two real replicas (below)
+```
+
+The smoke needs the end-to-end harness of [`e2e/`](../../e2e/README.md) running: start `flagnetic-e2e up` with
+`FLAGNETIC_E2E_SEED` naming a file, then run `uv run pytest e2e` with the same `FLAGNETIC_E2E_SEED` and, unless
+`flagnetic-e2e` is on the `PATH`, `FLAGNETIC_E2E_CMD` naming it. It ends by revoking the seed's server key, so bring
+the harness up again before running it a second time.
+
+The tests run the shared conformance suite in `conformance/` against the evaluator, play the protocol scenarios and degradation cases against a mock server through the public API, and measure that evaluating one flag of a 1,000-flag ruleset stays under a millisecond at the 99th percentile.

flagnetic-0.1.0/README.md

@@ -0,0 +1,146 @@
+# flagnetic
+
+Python SDK for [Flagnetic](https://github.com/azverinus/flagnetic), self-hosted feature flags and experiments.
+
+```bash
+pip install flagnetic
+```
+
+It needs Python 3.11 or later and installs no dependency: the package is pure Python, its regular expression engine
+included, so it installs the same on Alpine and on free-threaded builds. Supported: the Python releases still
+supported upstream (a release reaching its end of life is dropped in a minor version) and, with the extra,
+`openfeature-sdk` 0.9 and later. The package speaks the SDK API `/sdk/v1` and works with every Flagnetic server from
+0.1.0 on ([compatibility](../../docs/sdks/compatibility.md)); [docs/sdks/python.md](../../docs/sdks/python.md) is how
+it is deployed and tested.
+
+## Quick start
+
+```python
+import flagnetic
+
+client = flagnetic.Client("<server SDK key>", "https://flags.example.com")
+client.ready(timeout=5)  # fresh, last_good or built_in; never raises
+
+context = flagnetic.Context(units={"user": "u-1001"}, attributes={"plan": "pro"})
+if client.get_bool(context, "new-checkout", False):
+    ...
+
+client.close()
+```
+
+The getters never block and never raise: they read the ruleset the client holds and serve the default you pass when
+they cannot serve the flag. One background thread fetches the ruleset with `If-None-Match`, holds the ruleset stream
+(a kill switch reaches the client within two seconds), polls every 30 seconds while the stream is down, and backs
+off with jitter. `store="/var/lib/app/flagnetic.json"` keeps the last good ruleset across restarts.
+
+## Experiments and events
+
+The same thread reports an evaluation summary every minute (counts per flag, variation and reason, never a unit ID or
+a value) and sends exposures and aliases every two seconds, retrying with the same event IDs so the server drops a
+resend. An evaluation alone is not an exposure: call `exposure` where the unit actually meets the behaviour, or turn
+on automatic exposure for the flag.
+
+```python
+price = client.get_string(context, "pricing", "Built-in price")
+client.exposure(context, "pricing")  # reports the assignment just served
+client.alias("anonymous", "d-8f1c", "user", "u-1001")  # after sign-up
+client.flush(timeout=5)  # close() flushes too
+```
+
+## Pre-forking servers and asyncio
+
+Under gunicorn or uWSGI, build the client before the workers fork, or in each worker: a forked worker restarts the
+thread by itself, refetches and reports its own events. No hook is needed.
+
+The getters never block, so they are safe in a coroutine. Start-up and shutdown wait on a worker thread:
+
+```python
+stage = await client.aready(timeout=5)
+await client.aflush()
+await client.aclose()
+```
+
+## Tests and local overrides
+
+`flagnetic.testing` builds offline clients that make no request and start no thread:
+
+```python
+from flagnetic import testing
+
+client = testing.from_values({"new-checkout": True})  # or from_document(...), from_file(path)
+client.set("new-checkout", False)  # change listeners fire
+client.reload()  # back to what it was built from
+client.recorder.exposures()  # what it would have reported
+```
+
+`Client(..., allow_overrides=True)` enables `client.local_overrides.set(key, value)`, served with reason
+`local_override`; without the option `set` raises `LocalOverridesNotAllowed`, and a protected environment refuses and
+drops every local override.
+
+## OpenFeature
+
+```bash
+pip install 'flagnetic[openfeature]'
+```
+
+The extra installs `openfeature-sdk` 0.9 or later and the provider in `flagnetic.openfeature`. It takes the client's
+arguments and options and builds the client itself:
+
+```python
+from openfeature import api
+from openfeature.evaluation_context import EvaluationContext
+from openfeature.track import TrackingEventDetails
+from flagnetic.openfeature import Provider
+
+provider = Provider("<server SDK key>", "https://flags.example.com", unit_type="user")
+api.set_provider_and_wait(provider)  # api.set_provider before openfeature-sdk 0.10
+client = api.get_client()
+
+context = EvaluationContext("u-1001", {"plan": "pro", "units": {"account": "a-17"}})
+price = client.get_string_value("pricing", "Built-in price", context)
+client.track("exposure", context, TrackingEventDetails().add("flag", "pricing"))
+client.track(
+    "alias",
+    tracking_event_details=TrackingEventDetails()
+    .add("fromUnitType", "anonymous")
+    .add("fromUnitId", "d-8f1c")
+    .add("toUnitType", "user")
+    .add("toUnitId", "u-1001"),
+)
+```
+
+The targeting key is the unit ID of `unit_type`; the `units` attribute adds further units by unit type; every other
+attribute is an attribute of the context. Reasons map as in every Flagnetic provider:
+
+| Flagnetic | OpenFeature |
+|---|---|
+| `rule`, `prerequisite_failed`, `override`, `targeting_match` | `TARGETING_MATCH` |
+| `rollout`, `experiment` | `SPLIT` |
+| `fallthrough` | `DEFAULT` |
+| `off` | `DISABLED` |
+| `local_override` | `STATIC` |
+| `error` | `ERROR` |
+| `fallback` | `ERROR`, with `FLAG_NOT_FOUND`, `TYPE_MISMATCH` or `GENERAL` |
+
+The flag metadata carries the Flagnetic reason as `flagnetic_reason`, with `stage`, `ruleset_version`, `variation`,
+`overridden` and, for an experiment, its `experiment_*` fields. The provider emits `PROVIDER_CONFIGURATION_CHANGED`
+with the changed flag keys, `PROVIDER_STALE` while the client serves its last good ruleset, `PROVIDER_READY` once it
+is fresh again and `PROVIDER_ERROR` when the SDK key is revoked. Initialization waits up to `ready_timeout` seconds
+(default 10) for the first fetch and never fails. `provider.client` is the wrapped client, for local overrides,
+`flush` and the recorder of an offline provider (`Provider("", "", offline=document)`).
+
+## Development
+
+```bash
+uv sync --extra openfeature
+uv run ruff check . && uv run ruff format --check . && uv run mypy
+uv run pytest
+uv run pytest e2e  # the smoke against two real replicas (below)
+```
+
+The smoke needs the end-to-end harness of [`e2e/`](../../e2e/README.md) running: start `flagnetic-e2e up` with
+`FLAGNETIC_E2E_SEED` naming a file, then run `uv run pytest e2e` with the same `FLAGNETIC_E2E_SEED` and, unless
+`flagnetic-e2e` is on the `PATH`, `FLAGNETIC_E2E_CMD` naming it. It ends by revoking the seed's server key, so bring
+the harness up again before running it a second time.
+
+The tests run the shared conformance suite in `conformance/` against the evaluator, play the protocol scenarios and degradation cases against a mock server through the public API, and measure that evaluating one flag of a 1,000-flag ruleset stays under a millisecond at the 99th percentile.