mrflagly 0.2.5__cp312-none-win_amd64.whl

mrflagly/__init__.py

@@ -0,0 +1,5 @@
+from .mrflagly import *
+
+__doc__ = mrflagly.__doc__
+if hasattr(mrflagly, "__all__"):
+    __all__ = mrflagly.__all__

mrflagly-0.2.5.dist-info/METADATA

@@ -0,0 +1,121 @@
+Metadata-Version: 2.1
+Name: mrflagly
+Version: 0.2.5
+Classifier: Programming Language :: Rust
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Summary: No nonsense feature flagging system
+Home-Page: https://github.com/vangheem/mr.flagly
+Author-email: Nathan Van Gheem <vangheem@gmail.com>>
+License: MIT
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Source Code, https://github.com/vangheem/mr.flagly
+
+# Introduction
+
+Feature flagging should not be so complicated.
+
+Mr Flagly is a decentralized feature flagging system written in Rust with bindings for other languages.
+
+It does not depend on third party services or require you to deploy services and databases to manage.
+
+Supported feature flag definition sources:
+
+- URL
+- JSON Value
+- Environment Variable
+
+
+## Rust usage
+
+Setup your flag service:
+
+```rust
+use mrflagly::service::{FlagService, FlagServiceOptions};
+let flag_service = FlagService::new(FlagServiceOptions {
+    finder_type: mrflagly::service::types::FlagFinderType::URL,
+    url: "https://path/to/hosted/json/file",
+    refresh_interval: 600,
+    data: None,
+    env_var: None,
+})
+```
+
+Then, to check for feature flag:
+
+```rust
+if flag_service.enabled("feature_x", false /* default value */, Some(HashMap::from([(String::from("user_id"), String::from("123")),])) /* optional context */) {
+    // do something
+}
+```
+
+
+## Python support
+
+```python
+import mrflagly
+
+flag_service = mrflagly.FlagService(url="https://path/to/hosted/json/file")
+if flag_service.enabled("feature_x", default=False, context={"foo": "bar"}):
+    # do something
+```
+
+
+## FlagService constructor parameters
+
+- `finder_type`: (NULL, URL, JSON, ENVVAR)
+- `url`: URL to download feature flag json data
+- `refresh_interval`: How often to poll the feature flag data endpoint
+- `data`: Instead of hosting feature flag data from URL, you can provide it as a json blob
+- `env_var`: Provide feature flag data in environment variable
+
+
+
+## JSON format
+
+JSON format for feature flag data:
+
+```json
+{
+    "my_feature": {
+        "rollout": 100
+    },
+    "my_feature_with_variants": {
+        "rollout": 0,
+        "variants" {
+            "user_id": ["123"],
+            "company_id": ["123"]
+        }
+    }
+}
+```
+
+
+## Example activating for a particular customer
+
+JSON config data:
+
+```json
+{
+    "feature": {
+        "rollout": 0,
+        "variants": {
+            "customer_id": ["123"]
+        }
+    }
+}
+```
+
+
+Usage:
+```python
+import mrflagly
+import json
+
+flag_service = mrflagly.FlagService(
+    data=json.dumps({"feature": {"rollout": 0, "variants": {"customer_id": ["123"]}}}))
+
+if flag_service.enabled("feature_x", default=False, context={"customer_id": "123"}):
+    # do something
+```

mrflagly-0.2.5.dist-info/RECORD

@@ -0,0 +1,5 @@
+mrflagly-0.2.5.dist-info/METADATA,sha256=3AphGNP_BH2rRkGCVha5qg-6TJCde3ad0Y1dxs-rdzE,2929
+mrflagly-0.2.5.dist-info/WHEEL,sha256=ZTY_kOhWGECXxDmzhXy-zxezgT1DhbmPVnjnbRdLmy8,97
+mrflagly/__init__.py,sha256=Zc77-ZUJhQTZtqzyJiiJJOyozxkSOT8B9nZZ1w74g2c,115
+mrflagly/mrflagly.cp312-win_amd64.pyd,sha256=vMeoJTH79aoCOHep1FxsAipbn4VM3_TLsFLwNVpv7T8,1958912
+mrflagly-0.2.5.dist-info/RECORD,,

mrflagly-0.2.5.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: maturin (0.14.17)
+Root-Is-Purelib: false
+Tag: cp312-none-win_amd64