flipswitch-sdk 0.1.2__tar.gz

flipswitch_sdk-0.1.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Flipswitch
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

flipswitch_sdk-0.1.2/PKG-INFO

@@ -0,0 +1,166 @@
+Metadata-Version: 2.4
+Name: flipswitch-sdk
+Version: 0.1.2
+Summary: Flipswitch SDK with real-time SSE support for OpenFeature
+License: MIT
+Project-URL: Homepage, https://github.com/flipswitch-io/python-sdk
+Project-URL: Documentation, https://flipswitch.io/docs/sdks/python
+Project-URL: Repository, https://github.com/flipswitch-io/python-sdk
+Keywords: feature-flags,openfeature,flipswitch,sse,real-time
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+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: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: openfeature-sdk>=0.7.0
+Requires-Dist: openfeature-provider-ofrep>=0.2.0
+Requires-Dist: httpx>=0.27.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Requires-Dist: pytest-httpserver>=1.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23.0; extra == "dev"
+Dynamic: license-file
+
+# Flipswitch Python SDK
+
+[![CI](https://github.com/flipswitch-io/python-sdk/actions/workflows/ci.yml/badge.svg)](https://github.com/flipswitch-io/python-sdk/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/flipswitch-sdk.svg)](https://pypi.org/project/flipswitch-sdk/)
+
+Flipswitch SDK for Python with real-time SSE support for OpenFeature.
+
+## Installation
+
+```bash
+pip install flipswitch-sdk
+```
+
+## Quick Start
+
+```python
+from flipswitch import FlipswitchProvider
+from openfeature import api
+from openfeature.evaluation_context import EvaluationContext
+
+# Only API key is required
+provider = FlipswitchProvider(api_key="YOUR_API_KEY")
+
+# Register with OpenFeature
+api.set_provider(provider)
+
+# Get a client and evaluate flags
+client = api.get_client()
+dark_mode = client.get_boolean_value("dark-mode", False)
+welcome_message = client.get_string_value("welcome-message", "Hello!")
+```
+
+## Configuration Options
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `api_key` | `str` | *required* | Environment API key from dashboard |
+| `base_url` | `str` | `https://api.flipswitch.io` | Your Flipswitch server URL |
+| `enable_realtime` | `bool` | `True` | Enable SSE for real-time flag updates |
+
+```python
+provider = FlipswitchProvider(
+    api_key="YOUR_API_KEY",
+    base_url="https://api.flipswitch.io",
+    enable_realtime=True,
+)
+```
+
+## Evaluation Context
+
+Pass user attributes for targeting:
+
+```python
+context = EvaluationContext(
+    targeting_key="user-123",
+    attributes={
+        "email": "user@example.com",
+        "plan": "premium",
+        "country": "SE",
+    },
+)
+
+show_feature = client.get_boolean_value("new-feature", False, context)
+```
+
+## Real-Time Updates
+
+When `enable_realtime=True` (default), the SDK maintains an SSE connection to receive instant flag changes:
+
+### Event Listeners
+
+```python
+from flipswitch import FlagChangeEvent
+
+def on_flag_change(event: FlagChangeEvent):
+    print(f"Flag changed: {event.flag_key}")
+
+provider.add_flag_change_listener(on_flag_change)
+```
+
+### Connection Status
+
+```python
+# Check current SSE status
+status = provider.get_sse_status()
+# ConnectionStatus.CONNECTING, CONNECTED, DISCONNECTED, ERROR
+
+# Force reconnect
+provider.reconnect_sse()
+```
+
+## Bulk Flag Evaluation
+
+Evaluate all flags at once:
+
+```python
+# Evaluate all flags
+flags = provider.evaluate_all_flags(context)
+for flag in flags:
+    print(f"{flag.key} ({flag.value_type}): {flag.get_value_as_string()}")
+
+# Evaluate a single flag with full details
+flag = provider.evaluate_flag("dark-mode", context)
+if flag:
+    print(f"Value: {flag.value}, Reason: {flag.reason}, Variant: {flag.variant}")
+```
+
+## Shutdown
+
+Always shutdown the provider when done:
+
+```python
+provider.shutdown()
+```
+
+## Development
+
+```bash
+# Install with dev dependencies
+pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Run demo
+python examples/demo.py <api-key>
+```
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
+
+## License
+
+MIT - see [LICENSE](LICENSE) for details.

flipswitch_sdk-0.1.2/README.md

@@ -0,0 +1,135 @@
+# Flipswitch Python SDK
+
+[![CI](https://github.com/flipswitch-io/python-sdk/actions/workflows/ci.yml/badge.svg)](https://github.com/flipswitch-io/python-sdk/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/flipswitch-sdk.svg)](https://pypi.org/project/flipswitch-sdk/)
+
+Flipswitch SDK for Python with real-time SSE support for OpenFeature.
+
+## Installation
+
+```bash
+pip install flipswitch-sdk
+```
+
+## Quick Start
+
+```python
+from flipswitch import FlipswitchProvider
+from openfeature import api
+from openfeature.evaluation_context import EvaluationContext
+
+# Only API key is required
+provider = FlipswitchProvider(api_key="YOUR_API_KEY")
+
+# Register with OpenFeature
+api.set_provider(provider)
+
+# Get a client and evaluate flags
+client = api.get_client()
+dark_mode = client.get_boolean_value("dark-mode", False)
+welcome_message = client.get_string_value("welcome-message", "Hello!")
+```
+
+## Configuration Options
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `api_key` | `str` | *required* | Environment API key from dashboard |
+| `base_url` | `str` | `https://api.flipswitch.io` | Your Flipswitch server URL |
+| `enable_realtime` | `bool` | `True` | Enable SSE for real-time flag updates |
+
+```python
+provider = FlipswitchProvider(
+    api_key="YOUR_API_KEY",
+    base_url="https://api.flipswitch.io",
+    enable_realtime=True,
+)
+```
+
+## Evaluation Context
+
+Pass user attributes for targeting:
+
+```python
+context = EvaluationContext(
+    targeting_key="user-123",
+    attributes={
+        "email": "user@example.com",
+        "plan": "premium",
+        "country": "SE",
+    },
+)
+
+show_feature = client.get_boolean_value("new-feature", False, context)
+```
+
+## Real-Time Updates
+
+When `enable_realtime=True` (default), the SDK maintains an SSE connection to receive instant flag changes:
+
+### Event Listeners
+
+```python
+from flipswitch import FlagChangeEvent
+
+def on_flag_change(event: FlagChangeEvent):
+    print(f"Flag changed: {event.flag_key}")
+
+provider.add_flag_change_listener(on_flag_change)
+```
+
+### Connection Status
+
+```python
+# Check current SSE status
+status = provider.get_sse_status()
+# ConnectionStatus.CONNECTING, CONNECTED, DISCONNECTED, ERROR
+
+# Force reconnect
+provider.reconnect_sse()
+```
+
+## Bulk Flag Evaluation
+
+Evaluate all flags at once:
+
+```python
+# Evaluate all flags
+flags = provider.evaluate_all_flags(context)
+for flag in flags:
+    print(f"{flag.key} ({flag.value_type}): {flag.get_value_as_string()}")
+
+# Evaluate a single flag with full details
+flag = provider.evaluate_flag("dark-mode", context)
+if flag:
+    print(f"Value: {flag.value}, Reason: {flag.reason}, Variant: {flag.variant}")
+```
+
+## Shutdown
+
+Always shutdown the provider when done:
+
+```python
+provider.shutdown()
+```
+
+## Development
+
+```bash
+# Install with dev dependencies
+pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Run demo
+python examples/demo.py <api-key>
+```
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
+
+## License
+
+MIT - see [LICENSE](LICENSE) for details.

flipswitch_sdk-0.1.2/flipswitch/__init__.py

@@ -0,0 +1,44 @@
+"""
+Flipswitch SDK with real-time SSE support for OpenFeature.
+
+This SDK wraps OFREP-compatible flag evaluation with automatic
+cache invalidation via Server-Sent Events (SSE). When flags change
+in your Flipswitch dashboard, connected clients receive updates
+in real-time.
+
+Example:
+    >>> from flipswitch import FlipswitchProvider
+    >>> from openfeature import api
+    >>>
+    >>> # Only API key is required
+    >>> provider = FlipswitchProvider(api_key="your-api-key")
+    >>>
+    >>> api.set_provider(provider)
+    >>> client = api.get_client()
+    >>>
+    >>> # Flags automatically update when changed in dashboard
+    >>> dark_mode = client.get_boolean_value("dark-mode", False)
+"""
+
+from flipswitch.provider import FlipswitchProvider
+from flipswitch.sse_client import SseClient, ConnectionStatus
+from flipswitch.types import (
+    FlipswitchOptions,
+    FlagChangeEvent,
+    FlagUpdatedEvent,
+    ConfigUpdatedEvent,
+    FlagEvaluation,
+)
+
+__all__ = [
+    "FlipswitchProvider",
+    "SseClient",
+    "ConnectionStatus",
+    "FlipswitchOptions",
+    "FlagChangeEvent",
+    "FlagUpdatedEvent",
+    "ConfigUpdatedEvent",
+    "FlagEvaluation",
+]
+
+__version__ = "0.1.0"