featureflip-openfeature-provider 0.1.0__tar.gz

featureflip_openfeature_provider-0.1.0/.gitignore

@@ -0,0 +1,77 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# ruff
+.ruff_cache/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# uv lock file (optional, use pip with pyproject.toml)
+uv.lock

featureflip_openfeature_provider-0.1.0/CHANGELOG.md

@@ -0,0 +1,21 @@
+# Changelog
+
+## 0.1.0 — 2026-08-28
+
+Initial release of the OpenFeature provider for the Featureflip Python server SDK.
+
+### Added
+
+- `FeatureflipProvider`, backed by the Featureflip Python SDK. Construct it with an SDK key (the provider creates and owns the client) or with an existing `FeatureflipClient` (the caller keeps ownership, and the provider will not close it). The SDK key form defers client construction to `initialize()`, because `FeatureflipClient.__init__` blocks on the initial flag fetch — building it eagerly would move that wait out of `OpenFeature.set_provider_and_wait()` and into your constructor. ([#2586](https://github.com/canopy-labs/featureflip/issues/2586))
+
+- Context mapping: `targeting_key` becomes `user_id`, the canonical wire field that percentage rollouts bucket on, unless the caller already supplied `user_id` or its accepted alias `userId`. All other attributes pass through unchanged.
+
+- Reason mapping: `RULE_MATCH` → `TARGETING_MATCH`, `FALLTHROUGH` → `DEFAULT`, `FLAG_DISABLED` → `DISABLED`. An unmet prerequisite surfaces as the custom reason `PREREQUISITE_FAILED` — no standard OpenFeature reason models one, and reasons are open strings, so mislabelling it would be worse than naming it. `ruleId` and `prerequisiteKey` are carried in `flag_metadata`.
+
+- On an error reason (`FLAG_NOT_FOUND`/`ERROR`) the caller's default is returned rather than `detail.value`. The SDK's error details can carry a flag's off-variation value — a prerequisite chain past the depth limit, or an errored prerequisite — which would be wrong-typed, and the caller's default is what the OpenFeature error contract prescribes.
+
+- A runtime type guard enforcing OpenFeature's `TYPE_MISMATCH` contract, which Featureflip does not enforce itself. `get_integer_value` accepts whole-number floats (JSON does not distinguish `1` from `1.0`), `get_float_value` accepts any number, and `get_object_value` accepts objects and arrays but not strings. Booleans are rejected by both numeric accessors: `bool` is a subclass of `int` in Python, so without an explicit exclusion a boolean flag would satisfy `get_integer_value` and return `1`.
+
+- `PROVIDER_CONFIGURATION_CHANGED` is emitted whenever flag configuration changes, with `flags_changed` naming the affected keys. The initial load does not raise it — OpenFeature signals that with `PROVIDER_READY`. Requires `featureflip >= 2.7.0`, which added the underlying update hook.
+
+- `track()` forwards to the SDK's custom event tracking, mapping `TrackingEventDetails.attributes` to the event metadata and including a numeric `value` under the `value` key.

featureflip_openfeature_provider-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 2026 Canopy Labs LLC
+
+   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.

featureflip_openfeature_provider-0.1.0/PKG-INFO

@@ -0,0 +1,164 @@
+Metadata-Version: 2.5
+Name: featureflip-openfeature-provider
+Version: 0.1.0
+Summary: OpenFeature provider for Featureflip (Python server SDK)
+Project-URL: Homepage, https://featureflip.io
+Project-URL: Documentation, https://featureflip.io/docs/integrations/openfeature/
+Project-URL: Repository, https://github.com/canopy-labs/featureflip-python-openfeature
+Author: Featureflip Team
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: feature-flags,feature-toggles,featureflip,openfeature,provider
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+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: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: featureflip>=2.7.0
+Requires-Dist: openfeature-sdk>=0.8.0
+Provides-Extra: dev
+Requires-Dist: mypy>=1.8.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.3.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Featureflip OpenFeature Provider (Python)
+
+[OpenFeature](https://openfeature.dev/) provider for
+[Featureflip](https://featureflip.io), backed by the Featureflip Python server
+SDK. Use the vendor-neutral OpenFeature API while Featureflip serves your flags.
+
+## Installation
+
+```bash
+pip install featureflip-openfeature-provider
+```
+
+`featureflip` and `openfeature-sdk` are declared as lower-bounded dependencies
+rather than pinned — your application controls their versions, and a single
+`featureflip` copy is what lets this provider and any direct SDK usage share one
+underlying client core.
+
+## Quickstart
+
+```python
+from openfeature import api
+from featureflip_openfeature import FeatureflipProvider
+
+api.set_provider(FeatureflipProvider(sdk_key="your-server-sdk-key"))
+
+client = api.get_client()
+
+enabled = client.get_boolean_value(
+    "new-checkout",
+    False,
+    EvaluationContext(targeting_key="user-42", attributes={"plan": "pro"}),
+)
+```
+
+The provider owns the client it creates and closes it on shutdown. To share one
+client with code that uses the SDK directly, construct the client yourself and
+pass it in — the provider will not close a client it did not create:
+
+```python
+from featureflip import FeatureflipClient
+
+client = FeatureflipClient(sdk_key="your-server-sdk-key")
+api.set_provider(FeatureflipProvider(client=client))
+```
+
+Note that `FeatureflipClient(...)` blocks on the initial flag fetch. With the
+`sdk_key` form the provider defers that to `initialize()`, so the wait happens
+inside OpenFeature's provider setup rather than in your constructor.
+
+## Context mapping
+
+| OpenFeature context | Featureflip context |
+|---|---|
+| `targeting_key` | `user_id` (used for rollout bucketing) |
+| Any other attribute | Passed through unchanged |
+
+An explicit `user_id` (or its alias `userId`) attribute takes precedence over
+`targeting_key`. Without either, percentage rollouts bucketed by user serve the
+control variation — see the SDK's keyless-context behavior.
+
+## Evaluation reasons
+
+| Featureflip reason | OpenFeature reason |
+|---|---|
+| `RULE_MATCH` | `TARGETING_MATCH` |
+| `FALLTHROUGH` | `DEFAULT` |
+| `FLAG_DISABLED` | `DISABLED` |
+| `PREREQUISITE_FAILED` | `PREREQUISITE_FAILED` (custom) |
+| `FLAG_NOT_FOUND` | `ERROR` + `FLAG_NOT_FOUND` |
+| `ERROR` | `ERROR` + `GENERAL` |
+
+No standard OpenFeature reason models an unmet prerequisite. Reasons are open
+strings, so the provider surfaces `PREREQUISITE_FAILED` verbatim rather than
+mislabelling it.
+
+On an error reason the provider returns **your default value**, not the flag's
+off-variation — that value can be wrong-typed, and the caller's default is what
+the OpenFeature error contract prescribes.
+
+### Flag metadata
+
+Successful resolutions carry `ruleId` and `prerequisiteKey` in `flag_metadata`
+when the evaluation produced them.
+
+## Type handling
+
+Featureflip does not type-check flag values against the accessor you call, so
+the provider enforces OpenFeature's `TYPE_MISMATCH` contract itself. A
+mismatched read returns your default with reason `ERROR` and error code
+`TYPE_MISMATCH`.
+
+| Accessor | Accepts |
+|---|---|
+| `get_boolean_value` | booleans only |
+| `get_string_value` | strings only |
+| `get_integer_value` | integers, and whole-number floats (`1.0`, `1e2`) |
+| `get_float_value` | any JSON number, including integers |
+| `get_object_value` | objects and arrays only — not strings |
+
+Booleans are deliberately rejected by the numeric accessors. `bool` is a
+subclass of `int` in Python, so without an explicit exclusion a boolean flag
+would satisfy `get_integer_value` and hand you `1`.
+
+## Events
+
+The provider emits OpenFeature's `PROVIDER_CONFIGURATION_CHANGED` whenever
+Featureflip flag configuration changes, with `flags_changed` naming the affected
+keys:
+
+```python
+from openfeature.event import ProviderEvent
+
+client.add_handler(
+    ProviderEvent.PROVIDER_CONFIGURATION_CHANGED,
+    lambda details: print("changed:", details.flags_changed),
+)
+```
+
+The initial flag load does not raise this event — OpenFeature signals that with
+`PROVIDER_READY`. Beyond flags whose own configuration changed, the event also
+names flags whose evaluated value moves as a result: those referencing an edited
+segment, and those depending on a changed flag through a prerequisite.
+
+Requires `featureflip >= 2.7.0`, which added the underlying update hook.
+
+## Tracking
+
+`client.track(...)` forwards to the Featureflip SDK's custom event tracking.
+`TrackingEventDetails.attributes` become the event metadata, and a numeric
+`value` is included under the `value` key.
+
+## License
+
+Apache-2.0

featureflip_openfeature_provider-0.1.0/README.md

@@ -0,0 +1,134 @@
+# Featureflip OpenFeature Provider (Python)
+
+[OpenFeature](https://openfeature.dev/) provider for
+[Featureflip](https://featureflip.io), backed by the Featureflip Python server
+SDK. Use the vendor-neutral OpenFeature API while Featureflip serves your flags.
+
+## Installation
+
+```bash
+pip install featureflip-openfeature-provider
+```
+
+`featureflip` and `openfeature-sdk` are declared as lower-bounded dependencies
+rather than pinned — your application controls their versions, and a single
+`featureflip` copy is what lets this provider and any direct SDK usage share one
+underlying client core.
+
+## Quickstart
+
+```python
+from openfeature import api
+from featureflip_openfeature import FeatureflipProvider
+
+api.set_provider(FeatureflipProvider(sdk_key="your-server-sdk-key"))
+
+client = api.get_client()
+
+enabled = client.get_boolean_value(
+    "new-checkout",
+    False,
+    EvaluationContext(targeting_key="user-42", attributes={"plan": "pro"}),
+)
+```
+
+The provider owns the client it creates and closes it on shutdown. To share one
+client with code that uses the SDK directly, construct the client yourself and
+pass it in — the provider will not close a client it did not create:
+
+```python
+from featureflip import FeatureflipClient
+
+client = FeatureflipClient(sdk_key="your-server-sdk-key")
+api.set_provider(FeatureflipProvider(client=client))
+```
+
+Note that `FeatureflipClient(...)` blocks on the initial flag fetch. With the
+`sdk_key` form the provider defers that to `initialize()`, so the wait happens
+inside OpenFeature's provider setup rather than in your constructor.
+
+## Context mapping
+
+| OpenFeature context | Featureflip context |
+|---|---|
+| `targeting_key` | `user_id` (used for rollout bucketing) |
+| Any other attribute | Passed through unchanged |
+
+An explicit `user_id` (or its alias `userId`) attribute takes precedence over
+`targeting_key`. Without either, percentage rollouts bucketed by user serve the
+control variation — see the SDK's keyless-context behavior.
+
+## Evaluation reasons
+
+| Featureflip reason | OpenFeature reason |
+|---|---|
+| `RULE_MATCH` | `TARGETING_MATCH` |
+| `FALLTHROUGH` | `DEFAULT` |
+| `FLAG_DISABLED` | `DISABLED` |
+| `PREREQUISITE_FAILED` | `PREREQUISITE_FAILED` (custom) |
+| `FLAG_NOT_FOUND` | `ERROR` + `FLAG_NOT_FOUND` |
+| `ERROR` | `ERROR` + `GENERAL` |
+
+No standard OpenFeature reason models an unmet prerequisite. Reasons are open
+strings, so the provider surfaces `PREREQUISITE_FAILED` verbatim rather than
+mislabelling it.
+
+On an error reason the provider returns **your default value**, not the flag's
+off-variation — that value can be wrong-typed, and the caller's default is what
+the OpenFeature error contract prescribes.
+
+### Flag metadata
+
+Successful resolutions carry `ruleId` and `prerequisiteKey` in `flag_metadata`
+when the evaluation produced them.
+
+## Type handling
+
+Featureflip does not type-check flag values against the accessor you call, so
+the provider enforces OpenFeature's `TYPE_MISMATCH` contract itself. A
+mismatched read returns your default with reason `ERROR` and error code
+`TYPE_MISMATCH`.
+
+| Accessor | Accepts |
+|---|---|
+| `get_boolean_value` | booleans only |
+| `get_string_value` | strings only |
+| `get_integer_value` | integers, and whole-number floats (`1.0`, `1e2`) |
+| `get_float_value` | any JSON number, including integers |
+| `get_object_value` | objects and arrays only — not strings |
+
+Booleans are deliberately rejected by the numeric accessors. `bool` is a
+subclass of `int` in Python, so without an explicit exclusion a boolean flag
+would satisfy `get_integer_value` and hand you `1`.
+
+## Events
+
+The provider emits OpenFeature's `PROVIDER_CONFIGURATION_CHANGED` whenever
+Featureflip flag configuration changes, with `flags_changed` naming the affected
+keys:
+
+```python
+from openfeature.event import ProviderEvent
+
+client.add_handler(
+    ProviderEvent.PROVIDER_CONFIGURATION_CHANGED,
+    lambda details: print("changed:", details.flags_changed),
+)
+```
+
+The initial flag load does not raise this event — OpenFeature signals that with
+`PROVIDER_READY`. Beyond flags whose own configuration changed, the event also
+names flags whose evaluated value moves as a result: those referencing an edited
+segment, and those depending on a changed flag through a prerequisite.
+
+Requires `featureflip >= 2.7.0`, which added the underlying update hook.
+
+## Tracking
+
+`client.track(...)` forwards to the Featureflip SDK's custom event tracking.
+`TrackingEventDetails.attributes` become the event metadata, and a numeric
+`value` is included under the `value` key.
+
+## License
+
+Apache-2.0