nanoflags 0.1.0__tar.gz

nanoflags-0.1.0/.gitignore

@@ -0,0 +1,7 @@
+__pycache__/
+*.py[cod]
+.pytest_cache/
+*.egg-info/
+.venv/
+build/
+dist/

nanoflags-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.

nanoflags-0.1.0/NOTICE

@@ -0,0 +1,4 @@
+NanoFlags
+Copyright 2026 Alibtekarat Althkiya Company for Trading & Marketing (Intinovate)
+
+This product is licensed under the Apache License, Version 2.0 (see LICENSE).

nanoflags-0.1.0/PKG-INFO

@@ -0,0 +1,180 @@
+Metadata-Version: 2.5
+Name: nanoflags
+Version: 0.1.0
+Summary: NanoFlags server SDK for Python: local, deterministic feature-flag evaluation with signed live updates.
+Project-URL: Homepage, https://nanoflags.io
+Project-URL: Source, https://github.com/motazalmaroai/nanoflags-sdk
+Project-URL: Issues, https://github.com/motazalmaroai/nanoflags-sdk/issues
+Author-email: "Alibtekarat Althkiya Company for Trading & Marketing (Intinovate)" <support@nanoflags.io>
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: feature flags,feature toggles,nanoflags,openfeature,rollout
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+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: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: cryptography>=41
+Requires-Dist: websockets>=15.0
+Provides-Extra: openfeature
+Requires-Dist: openfeature-sdk>=0.8.0; extra == 'openfeature'
+Provides-Extra: test
+Requires-Dist: pytest>=7; extra == 'test'
+Description-Content-Type: text/markdown
+
+# nanoflags (Python)
+
+Server SDK for [NanoFlags](https://nanoflags.io) feature flags. Flags are evaluated **locally and synchronously**
+against a signed, in-memory configuration bundle; a variation call never does I/O and never raises. Background
+threads keep the bundle current over the edge's live WebSocket (`/v1/live`), falling back to SSE and polling.
+
+- Python 3.9+, fully typed (`py.typed`). Dependencies: `cryptography` (Ed25519) and `websockets`.
+- Pure-Python port of the NanoFlags engine, checked against the TypeScript engine with ~22 000 shared parity
+  fixtures (`packages/engine/fixtures/parity.json`).
+- Signature verification **on by default** against the hosted edge's embedded key list; unsigned or tampered
+  bundles are refused and the last good configuration stays in use.
+- Thread-safe; an `asyncio` wrapper and an OpenFeature provider (`nanoflags[openfeature]`) are included.
+
+## Install
+
+```sh
+pip install nanoflags
+pip install "nanoflags[openfeature]"   # with the OpenFeature provider
+```
+
+## Quickstart
+
+```python
+import os
+from nanoflags import NanoFlags
+
+flags = NanoFlags(
+    os.environ["NANOFLAGS_SDK_KEY"],      # nf_srv_… (server view) or nf_pub_… (client-exposed flags only)
+    service="checkout-api",               # shown in "which revision is each service running"
+)
+flags.wait_until_ready(timeout=5)         # never raises; True once a configuration is in use
+
+user = {"key": "user-42", "plan": "beta", "region": "DE"}
+if flags.bool_variation("new-checkout", False, user):
+    ...
+accent = flags.string_variation("accent", "blue", user)
+limit = flags.number_variation("rate-limit", 100, user)
+layout = flags.json_variation("layout", {"cols": 3}, user)
+
+detail = flags.bool_variation_detail("new-checkout", False, user)
+print(detail.value, detail.reason, detail.rule_id, detail.revision)   # True rule_match beta 57
+
+flags.on_change(lambda e: print(f"now on r{e.revision} via {e.transport}, {e.latency_ms} ms after commit"))
+
+flags.close()   # on shutdown (or use `with NanoFlags(...) as flags:`)
+```
+
+Create **one client per process** and share it between threads. Each variation takes the flag key, the value to
+serve when the flag cannot be evaluated (no configuration yet, unknown flag, value of another type), and the
+context: a dict of JSON-like attributes. `key` is the stable identity used for percentage rollouts.
+
+### asyncio
+
+```python
+from nanoflags.aio import AsyncNanoFlags
+
+async with AsyncNanoFlags(sdk_key, service="api") as flags:
+    await flags.wait_until_ready(5)
+    enabled = flags.bool_variation("new-checkout", False, {"key": user_id})   # local, no await needed
+```
+
+`on_change` accepts coroutine functions; they run on the event loop that created the client.
+
+### OpenFeature
+
+```python
+from openfeature import api
+from openfeature.evaluation_context import EvaluationContext
+from nanoflags import NanoFlags
+from nanoflags.openfeature import NanoFlagsProvider
+
+provider = NanoFlagsProvider(NanoFlags(sdk_key), close_client=True)
+api.set_provider_and_wait(provider)   # openfeature-sdk >= 0.9; on 0.8 use api.set_provider(provider)
+client = api.get_client()
+client.get_boolean_value("new-checkout", False, EvaluationContext(targeting_key="user-42"))
+```
+
+`targeting_key` becomes `key`. Reasons: disabled flag → `DISABLED`, no rule matched → `DEFAULT`, fixed rule →
+`TARGETING_MATCH`, rollout → `SPLIT` (variant = rule id). Unknown flags → `FLAG_NOT_FOUND`, wrong type →
+`TYPE_MISMATCH`. The float accessor accepts whole numbers. New revisions emit `PROVIDER_CONFIGURATION_CHANGED`;
+status changes emit `PROVIDER_READY` / `PROVIDER_STALE`.
+
+## API
+
+| | |
+| --- | --- |
+| `NanoFlags(sdk_key, *, base_url, service, poll_interval, streaming, live, live_poll_interval, bootstrap, cache_path, store, events, verify, on_change, on_error, start)` | the client |
+| `bool_variation` / `string_variation` / `number_variation` / `json_variation(key, default, context=None)` | typed value |
+| `*_variation_detail(...)` → `Evaluation` | `value`, `reason` (`rule_match`, `default`, `off`, `flag_not_found`, `error`), `rule_index`, `rule_id`, `in_rollout`, `bucket`, `revision`, `trace`, `error` |
+| `evaluate(key, default, context)` | engine result without a type check |
+| `all_flags(context)` → `dict` | every flag of the loaded configuration |
+| `wait_until_ready(timeout)` / `ready(timeout)` → `bool` | blocks until a configuration is in use or the first load failed |
+| `status` (`not-ready` / `ready` / `stale`), `revision`, `transport` (`live` / `stream` / `poll`) | state |
+| `on_change(cb)`, `on_error(cb)`, `on("update" \| "error" \| "status", cb)` → unsubscribe | listeners |
+| `refresh()`, `flush()`, `close()` | revalidate now, send telemetry now, stop |
+| `session(token, service=None)` → `SessionEvaluator` | test-session override (below) |
+
+`base_url` defaults to the hosted edge `https://edge.nanoflags.io`. Errors are delivered to `on_error` as
+`NanoFlagsError` with a `code`: `network`, `unauthorized`, `http`, `invalid_bundle`, `store`, `config`, `signature`,
+`session`, `engine`, `environment_deleted`. Nothing is ever raised from a variation call.
+
+## Behaviour
+
+- **Fallbacks and staleness.** Until a configuration loads, variations return your default. Once loaded, the
+  last good configuration stays in use through network failures (`status` becomes `stale`).
+- **Live updates.** The client opens `wss://<edge>/v1/live` (key in the `Authorization` header, never in the URL).
+  The edge pushes each signed revision; it is verified and swapped atomically. Pings every ~30 s, a socket is
+  replaced every ~50 min (the edge drops sockets older than 2 h), reconnects back off 1 s · 2ⁿ × 0.5–1.5 up to 5 min.
+  While the socket is healthy the safety poll runs every 5 minutes; without it, SSE (`/v1/stream`) plus polling
+  every 30 s take over. HTTP and WebSocket honour `HTTPS_PROXY` and `SSL_CERT_FILE`.
+- **Signature verification.** Every bundle is checked (Ed25519 over the canonical string, by `kid`) before it can
+  replace the current one. With the hosted edge this is on by default with the embedded production keys
+  (`OFFICIAL_SIGNING_KEYS`) and unsigned bundles are refused; a bundle naming an unknown `kid` (key rotation) loads
+  `GET /v1/keys` once (at most once a minute). For a self-hosted edge pass
+  `verify=VerifyOptions(public_keys=[jwk], require=True)` (or `public_keys="fetch"`); `verify=False` turns it off.
+  The raw signed bytes are hashed exactly as served — never a re-serialisation.
+- **Persistence and bootstrap.** `cache_path="/var/cache/app/flags.json"` keeps the last good bundle (atomic
+  write, mode 0600) and restores it on start as `stale` until the edge confirms it; a restored copy is verified
+  again and ignored if it does not verify. `bootstrap=` takes a bundle (dict or JSON text) to serve immediately.
+- **Engine version.** Bundles produced for a newer evaluation engine (`bundle.engine` > `ENGINE_VERSION`) are
+  refused (`code="engine"`) and the current configuration stays in use: upgrade the SDK.
+- **Deleted environment.** When the edge closes the socket with `4004 environment_deleted`, the client stops
+  reconnecting (no SSE fallback either), keeps the last configuration as `stale`, and reports
+  `code="environment_deleted"`. The regular poll continues and reports the key as rejected.
+- **Telemetry.** A sampled 10 % of evaluations are sent every 10 s, plus a service report every 60 s. Context
+  **values never leave the process** by default: only the names (and value types) of the attributes the flag's
+  rules use. `events=EventsOptions(redact=...)` customises this; `events=False` turns it off.
+- **Test sessions.** `flags.session(request.headers.get("x-nanoflags-session"))` returns an evaluator pinned to the
+  session's configuration and context while the session is active (resolved once per token, cached until it
+  expires), and behaves like the client otherwise.
+- **Threads.** The bundle is replaced as a single reference, so concurrent evaluations always see one consistent
+  revision. Background work runs on daemon threads; call `close()` to stop it and flush telemetry.
+
+## Development
+
+```sh
+pip install -e ".[openfeature,test]"
+pytest
+```
+
+`tests/test_parity.py` runs the shared engine fixtures (`../engine/fixtures/parity.json`, or
+`NANOFLAGS_PARITY_FIXTURES=<path>`); regenerate them with `node packages/engine/fixtures/generate-parity.mjs`.
+`scripts/live_verify.py` checks a client against the hosted edge with the public demo (see the script).
+
+## License
+
+Apache-2.0. See `LICENSE` and `NOTICE`.

nanoflags-0.1.0/README.md

@@ -0,0 +1,147 @@
+# nanoflags (Python)
+
+Server SDK for [NanoFlags](https://nanoflags.io) feature flags. Flags are evaluated **locally and synchronously**
+against a signed, in-memory configuration bundle; a variation call never does I/O and never raises. Background
+threads keep the bundle current over the edge's live WebSocket (`/v1/live`), falling back to SSE and polling.
+
+- Python 3.9+, fully typed (`py.typed`). Dependencies: `cryptography` (Ed25519) and `websockets`.
+- Pure-Python port of the NanoFlags engine, checked against the TypeScript engine with ~22 000 shared parity
+  fixtures (`packages/engine/fixtures/parity.json`).
+- Signature verification **on by default** against the hosted edge's embedded key list; unsigned or tampered
+  bundles are refused and the last good configuration stays in use.
+- Thread-safe; an `asyncio` wrapper and an OpenFeature provider (`nanoflags[openfeature]`) are included.
+
+## Install
+
+```sh
+pip install nanoflags
+pip install "nanoflags[openfeature]"   # with the OpenFeature provider
+```
+
+## Quickstart
+
+```python
+import os
+from nanoflags import NanoFlags
+
+flags = NanoFlags(
+    os.environ["NANOFLAGS_SDK_KEY"],      # nf_srv_… (server view) or nf_pub_… (client-exposed flags only)
+    service="checkout-api",               # shown in "which revision is each service running"
+)
+flags.wait_until_ready(timeout=5)         # never raises; True once a configuration is in use
+
+user = {"key": "user-42", "plan": "beta", "region": "DE"}
+if flags.bool_variation("new-checkout", False, user):
+    ...
+accent = flags.string_variation("accent", "blue", user)
+limit = flags.number_variation("rate-limit", 100, user)
+layout = flags.json_variation("layout", {"cols": 3}, user)
+
+detail = flags.bool_variation_detail("new-checkout", False, user)
+print(detail.value, detail.reason, detail.rule_id, detail.revision)   # True rule_match beta 57
+
+flags.on_change(lambda e: print(f"now on r{e.revision} via {e.transport}, {e.latency_ms} ms after commit"))
+
+flags.close()   # on shutdown (or use `with NanoFlags(...) as flags:`)
+```
+
+Create **one client per process** and share it between threads. Each variation takes the flag key, the value to
+serve when the flag cannot be evaluated (no configuration yet, unknown flag, value of another type), and the
+context: a dict of JSON-like attributes. `key` is the stable identity used for percentage rollouts.
+
+### asyncio
+
+```python
+from nanoflags.aio import AsyncNanoFlags
+
+async with AsyncNanoFlags(sdk_key, service="api") as flags:
+    await flags.wait_until_ready(5)
+    enabled = flags.bool_variation("new-checkout", False, {"key": user_id})   # local, no await needed
+```
+
+`on_change` accepts coroutine functions; they run on the event loop that created the client.
+
+### OpenFeature
+
+```python
+from openfeature import api
+from openfeature.evaluation_context import EvaluationContext
+from nanoflags import NanoFlags
+from nanoflags.openfeature import NanoFlagsProvider
+
+provider = NanoFlagsProvider(NanoFlags(sdk_key), close_client=True)
+api.set_provider_and_wait(provider)   # openfeature-sdk >= 0.9; on 0.8 use api.set_provider(provider)
+client = api.get_client()
+client.get_boolean_value("new-checkout", False, EvaluationContext(targeting_key="user-42"))
+```
+
+`targeting_key` becomes `key`. Reasons: disabled flag → `DISABLED`, no rule matched → `DEFAULT`, fixed rule →
+`TARGETING_MATCH`, rollout → `SPLIT` (variant = rule id). Unknown flags → `FLAG_NOT_FOUND`, wrong type →
+`TYPE_MISMATCH`. The float accessor accepts whole numbers. New revisions emit `PROVIDER_CONFIGURATION_CHANGED`;
+status changes emit `PROVIDER_READY` / `PROVIDER_STALE`.
+
+## API
+
+| | |
+| --- | --- |
+| `NanoFlags(sdk_key, *, base_url, service, poll_interval, streaming, live, live_poll_interval, bootstrap, cache_path, store, events, verify, on_change, on_error, start)` | the client |
+| `bool_variation` / `string_variation` / `number_variation` / `json_variation(key, default, context=None)` | typed value |
+| `*_variation_detail(...)` → `Evaluation` | `value`, `reason` (`rule_match`, `default`, `off`, `flag_not_found`, `error`), `rule_index`, `rule_id`, `in_rollout`, `bucket`, `revision`, `trace`, `error` |
+| `evaluate(key, default, context)` | engine result without a type check |
+| `all_flags(context)` → `dict` | every flag of the loaded configuration |
+| `wait_until_ready(timeout)` / `ready(timeout)` → `bool` | blocks until a configuration is in use or the first load failed |
+| `status` (`not-ready` / `ready` / `stale`), `revision`, `transport` (`live` / `stream` / `poll`) | state |
+| `on_change(cb)`, `on_error(cb)`, `on("update" \| "error" \| "status", cb)` → unsubscribe | listeners |
+| `refresh()`, `flush()`, `close()` | revalidate now, send telemetry now, stop |
+| `session(token, service=None)` → `SessionEvaluator` | test-session override (below) |
+
+`base_url` defaults to the hosted edge `https://edge.nanoflags.io`. Errors are delivered to `on_error` as
+`NanoFlagsError` with a `code`: `network`, `unauthorized`, `http`, `invalid_bundle`, `store`, `config`, `signature`,
+`session`, `engine`, `environment_deleted`. Nothing is ever raised from a variation call.
+
+## Behaviour
+
+- **Fallbacks and staleness.** Until a configuration loads, variations return your default. Once loaded, the
+  last good configuration stays in use through network failures (`status` becomes `stale`).
+- **Live updates.** The client opens `wss://<edge>/v1/live` (key in the `Authorization` header, never in the URL).
+  The edge pushes each signed revision; it is verified and swapped atomically. Pings every ~30 s, a socket is
+  replaced every ~50 min (the edge drops sockets older than 2 h), reconnects back off 1 s · 2ⁿ × 0.5–1.5 up to 5 min.
+  While the socket is healthy the safety poll runs every 5 minutes; without it, SSE (`/v1/stream`) plus polling
+  every 30 s take over. HTTP and WebSocket honour `HTTPS_PROXY` and `SSL_CERT_FILE`.
+- **Signature verification.** Every bundle is checked (Ed25519 over the canonical string, by `kid`) before it can
+  replace the current one. With the hosted edge this is on by default with the embedded production keys
+  (`OFFICIAL_SIGNING_KEYS`) and unsigned bundles are refused; a bundle naming an unknown `kid` (key rotation) loads
+  `GET /v1/keys` once (at most once a minute). For a self-hosted edge pass
+  `verify=VerifyOptions(public_keys=[jwk], require=True)` (or `public_keys="fetch"`); `verify=False` turns it off.
+  The raw signed bytes are hashed exactly as served — never a re-serialisation.
+- **Persistence and bootstrap.** `cache_path="/var/cache/app/flags.json"` keeps the last good bundle (atomic
+  write, mode 0600) and restores it on start as `stale` until the edge confirms it; a restored copy is verified
+  again and ignored if it does not verify. `bootstrap=` takes a bundle (dict or JSON text) to serve immediately.
+- **Engine version.** Bundles produced for a newer evaluation engine (`bundle.engine` > `ENGINE_VERSION`) are
+  refused (`code="engine"`) and the current configuration stays in use: upgrade the SDK.
+- **Deleted environment.** When the edge closes the socket with `4004 environment_deleted`, the client stops
+  reconnecting (no SSE fallback either), keeps the last configuration as `stale`, and reports
+  `code="environment_deleted"`. The regular poll continues and reports the key as rejected.
+- **Telemetry.** A sampled 10 % of evaluations are sent every 10 s, plus a service report every 60 s. Context
+  **values never leave the process** by default: only the names (and value types) of the attributes the flag's
+  rules use. `events=EventsOptions(redact=...)` customises this; `events=False` turns it off.
+- **Test sessions.** `flags.session(request.headers.get("x-nanoflags-session"))` returns an evaluator pinned to the
+  session's configuration and context while the session is active (resolved once per token, cached until it
+  expires), and behaves like the client otherwise.
+- **Threads.** The bundle is replaced as a single reference, so concurrent evaluations always see one consistent
+  revision. Background work runs on daemon threads; call `close()` to stop it and flush telemetry.
+
+## Development
+
+```sh
+pip install -e ".[openfeature,test]"
+pytest
+```
+
+`tests/test_parity.py` runs the shared engine fixtures (`../engine/fixtures/parity.json`, or
+`NANOFLAGS_PARITY_FIXTURES=<path>`); regenerate them with `node packages/engine/fixtures/generate-parity.mjs`.
+`scripts/live_verify.py` checks a client against the hosted edge with the public demo (see the script).
+
+## License
+
+Apache-2.0. See `LICENSE` and `NOTICE`.

nanoflags-0.1.0/pyproject.toml

@@ -0,0 +1,51 @@
+[build-system]
+requires = ["hatchling>=1.27"]
+build-backend = "hatchling.build"
+
+[project]
+name = "nanoflags"
+version = "0.1.0"
+description = "NanoFlags server SDK for Python: local, deterministic feature-flag evaluation with signed live updates."
+readme = "README.md"
+requires-python = ">=3.9"
+license = "Apache-2.0"
+license-files = ["LICENSE", "NOTICE"]
+authors = [{ name = "Alibtekarat Althkiya Company for Trading & Marketing (Intinovate)", email = "support@nanoflags.io" }]
+keywords = ["feature flags", "feature toggles", "nanoflags", "openfeature", "rollout"]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Intended Audience :: Developers",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Topic :: Software Development :: Libraries",
+  "Typing :: Typed",
+]
+dependencies = [
+  "cryptography>=41",
+  "websockets>=15.0",
+]
+
+[project.optional-dependencies]
+openfeature = ["openfeature-sdk>=0.8.0"]
+test = ["pytest>=7"]
+
+[project.urls]
+Homepage = "https://nanoflags.io"
+Source = "https://github.com/motazalmaroai/nanoflags-sdk"
+Issues = "https://github.com/motazalmaroai/nanoflags-sdk/issues"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/nanoflags"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src/nanoflags", "tests", "README.md", "LICENSE", "NOTICE", "pyproject.toml"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+markers = ["production: talks to the hosted edge (opt in with NANOFLAGS_PRODUCTION_TESTS=1)"]

nanoflags-0.1.0/src/nanoflags/__init__.py

@@ -0,0 +1,50 @@
+"""NanoFlags server SDK for Python.
+
+Flags are evaluated locally and synchronously against a signed, in-memory configuration bundle that is
+kept current in the background (live WebSocket, SSE or polling). See the README for a quickstart.
+"""
+
+from .client import (
+    CLOSE_ENVIRONMENT_DELETED,
+    LIVE_PROTOCOL,
+    SDK_VERSION,
+    SESSION_HEADER,
+    SUPPORTED_ENGINE_VERSION,
+    EventsOptions,
+    NanoFlags,
+    NanoFlagsError,
+    SessionEvaluator,
+    UpdateEvent,
+    VerifyOptions,
+)
+from .engine import ENGINE_VERSION, Evaluation, TraceStep
+from .keys import OFFICIAL_EDGE_URL, OFFICIAL_SIGNING_KEYS
+from .store import FileStore, Store
+
+#: Alias: the detail returned by ``*_variation_detail`` (value, reason, matched rule, trace).
+EvaluationDetail = Evaluation
+
+__version__ = SDK_VERSION
+
+__all__ = [
+    "CLOSE_ENVIRONMENT_DELETED",
+    "ENGINE_VERSION",
+    "Evaluation",
+    "EvaluationDetail",
+    "EventsOptions",
+    "FileStore",
+    "LIVE_PROTOCOL",
+    "NanoFlags",
+    "NanoFlagsError",
+    "OFFICIAL_EDGE_URL",
+    "OFFICIAL_SIGNING_KEYS",
+    "SDK_VERSION",
+    "SESSION_HEADER",
+    "SUPPORTED_ENGINE_VERSION",
+    "SessionEvaluator",
+    "Store",
+    "TraceStep",
+    "UpdateEvent",
+    "VerifyOptions",
+    "__version__",
+]