rollgate 1.0.0__py3-none-any.whl

rollgate-1.0.0.dist-info/METADATA

@@ -0,0 +1,288 @@
+Metadata-Version: 2.4
+Name: rollgate
+Version: 1.0.0
+Summary: Python SDK for Rollgate feature flags
+Project-URL: Homepage, https://rollgate.io
+Project-URL: Documentation, https://rollgate.io/docs/sdk/python
+Project-URL: Repository, https://github.com/thejord-it/rollgate
+Author-email: Rollgate <hello@rollgate.io>
+License-Expression: MIT
+Keywords: feature-flags,feature-toggles,rollgate,sdk
+Classifier: Development Status :: 5 - Production/Stable
+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: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: httpx-sse>=0.4.0
+Requires-Dist: httpx>=0.25.0
+Provides-Extra: dev
+Requires-Dist: mypy>=1.0.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.21.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
+Requires-Dist: pytest>=7.0.0; extra == 'dev'
+Requires-Dist: respx>=0.20.0; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Rollgate Python SDK
+
+[![CI](https://github.com/rollgate/sdks/actions/workflows/ci.yml/badge.svg)](https://github.com/rollgate/sdks/actions/workflows/ci.yml)
+[![PyPI version](https://img.shields.io/pypi/v/rollgate.svg)](https://pypi.org/project/rollgate/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+Official Python SDK for [Rollgate](https://rollgate.io) - Feature flags made simple.
+
+## Requirements
+
+- Python 3.9+
+- httpx >= 0.25.0
+- httpx-sse >= 0.4.0
+
+## Installation
+
+```bash
+pip install rollgate
+```
+
+## Quick Start
+
+```python
+import asyncio
+from rollgate import RollgateClient, RollgateConfig, UserContext
+
+async def main():
+    # Initialize client
+    config = RollgateConfig(api_key="your-api-key")
+    client = RollgateClient(config)
+
+    # Initialize and fetch flags
+    await client.init()
+
+    # Check if feature is enabled
+    if client.is_enabled("new-feature"):
+        print("New feature is enabled!")
+
+    # With user targeting
+    await client.identify(UserContext(
+        id="user-123",
+        email="user@example.com",
+        attributes={"plan": "pro", "country": "IT"}
+    ))
+
+    if client.is_enabled("premium-feature"):
+        print("Premium feature is enabled for this user!")
+
+    # Cleanup
+    await client.close()
+
+asyncio.run(main())
+```
+
+## Context Manager
+
+```python
+async with RollgateClient(RollgateConfig(api_key="your-api-key")) as client:
+    if client.is_enabled("my-feature"):
+        # Feature is enabled
+        pass
+```
+
+## Configuration
+
+```python
+from rollgate import (
+    RollgateConfig,
+    RetryConfig,
+    CircuitBreakerConfig,
+    CacheConfig,
+)
+
+config = RollgateConfig(
+    api_key="your-api-key",
+    base_url="https://api.rollgate.io",  # Custom API URL
+    refresh_interval_ms=30000,  # Polling interval (30s default)
+    enable_streaming=False,  # Use SSE for real-time updates
+    timeout_ms=5000,  # Request timeout
+
+    # Retry configuration
+    retry=RetryConfig(
+        max_retries=3,
+        base_delay_ms=100,
+        max_delay_ms=10000,
+        jitter_factor=0.1,
+    ),
+
+    # Circuit breaker configuration
+    circuit_breaker=CircuitBreakerConfig(
+        failure_threshold=5,
+        recovery_timeout_ms=30000,
+        monitoring_window_ms=60000,
+        success_threshold=3,
+    ),
+
+    # Cache configuration
+    cache=CacheConfig(
+        ttl_ms=300000,  # 5 minutes
+        stale_ttl_ms=3600000,  # 1 hour
+        persist_path="/tmp/rollgate-cache.json",  # Optional persistence
+    ),
+)
+```
+
+## Events
+
+```python
+client = RollgateClient(config)
+
+# Register event callbacks
+client.on("ready", lambda: print("Client ready"))
+client.on("flags_updated", lambda flags: print(f"Flags updated: {flags}"))
+client.on("flag_changed", lambda key, new, old: print(f"{key}: {old} -> {new}"))
+client.on("error", lambda err: print(f"Error: {err}"))
+client.on("circuit_open", lambda *args: print("Circuit breaker opened"))
+client.on("circuit_closed", lambda: print("Circuit breaker closed"))
+
+await client.init()
+```
+
+## Features
+
+### Polling (Default)
+
+By default, the SDK polls for flag updates every 30 seconds.
+
+```python
+config = RollgateConfig(
+    api_key="your-api-key",
+    refresh_interval_ms=30000,  # Poll every 30s
+)
+```
+
+### SSE Streaming
+
+Enable Server-Sent Events for real-time flag updates:
+
+```python
+config = RollgateConfig(
+    api_key="your-api-key",
+    enable_streaming=True,
+)
+```
+
+### Circuit Breaker
+
+The SDK includes a circuit breaker to prevent cascading failures:
+
+```python
+# Check circuit state
+state = client.circuit_state  # CircuitState.CLOSED, OPEN, or HALF_OPEN
+
+# Get statistics
+stats = client.get_circuit_stats()
+
+# Force reset
+client.reset_circuit()
+```
+
+### Caching
+
+Flags are cached locally with stale-while-revalidate support:
+
+```python
+# Get cache statistics
+stats = client.get_cache_stats()
+hit_rate = client.get_cache_hit_rate()
+
+# Clear cache
+client.clear_cache()
+```
+
+### Error Handling
+
+```python
+from rollgate import (
+    RollgateError,
+    AuthenticationError,
+    NetworkError,
+    RateLimitError,
+)
+
+try:
+    await client.init()
+except AuthenticationError as e:
+    print(f"Invalid API key: {e}")
+except NetworkError as e:
+    print(f"Network error: {e}")
+except RateLimitError as e:
+    print(f"Rate limited, retry after: {e.retry_after}s")
+except RollgateError as e:
+    print(f"Rollgate error: {e}")
+```
+
+## API Reference
+
+### RollgateClient
+
+| Method                                  | Description                        |
+| --------------------------------------- | ---------------------------------- |
+| `init(user?)`                           | Initialize client and fetch flags  |
+| `is_enabled(flag_key, default?)`        | Check if flag is enabled           |
+| `is_enabled_detail(flag_key, default?)` | Check flag with evaluation reason  |
+| `get_all_flags()`                       | Get all flags as dictionary        |
+| `identify(user)`                        | Set user context and refresh flags |
+| `reset()`                               | Clear user context                 |
+| `refresh()`                             | Force refresh flags                |
+| `close()`                               | Cleanup resources                  |
+
+### Evaluation Reasons
+
+Get detailed information about why a flag evaluated to a particular value:
+
+```python
+detail = client.is_enabled_detail("my-flag", False)
+print(detail.value)        # bool
+print(detail.reason.kind)  # "OFF", "TARGET_MATCH", "RULE_MATCH", "FALLTHROUGH", "ERROR", "UNKNOWN"
+```
+
+Reason kinds:
+
+| Kind           | Description                        |
+| -------------- | ---------------------------------- |
+| `OFF`          | Flag is disabled                   |
+| `TARGET_MATCH` | User is in the flag's target list  |
+| `RULE_MATCH`   | User matched a targeting rule      |
+| `FALLTHROUGH`  | Default rollout (no rules matched) |
+| `ERROR`        | Error during evaluation            |
+| `UNKNOWN`      | Flag not found                     |
+
+### UserContext
+
+| Field        | Type    | Description                     |
+| ------------ | ------- | ------------------------------- |
+| `id`         | `str`   | User identifier (required)      |
+| `email`      | `str?`  | User email                      |
+| `attributes` | `dict?` | Custom attributes for targeting |
+
+## Documentation
+
+- [Getting Started](../../docs/GETTING-STARTED.md)
+- [Architecture](../../docs/ARCHITECTURE.md)
+- [Production Setup](../../docs/PRODUCTION-SETUP.md)
+
+Full documentation: [docs.rollgate.io](https://rollgate.io/docs)
+
+## About Rollgate
+
+[Rollgate](https://rollgate.io) is a feature management platform that helps teams release features safely with gradual rollouts, user targeting, and instant kill switches.
+
+## License
+
+MIT

rollgate-1.0.0.dist-info/RECORD

@@ -0,0 +1,14 @@
+rollgate/__init__.py,sha256=SyOLOjfZblOv3AtKLLr96eEjYGEfQpiHZUrH2g_dv9I,2970
+rollgate/cache.py,sha256=XjjRrbOsnR9lRGE6HjYmstq5BtQLFhbx6P4A4XRSmto,7634
+rollgate/circuit_breaker.py,sha256=RWQE0I90F1-0OHa1xDtenCez9P7kU2CYq8JjQCyJ1Q8,8121
+rollgate/client.py,sha256=F1jwY_H8arx5Pf25KBk5zfZty3D0TZ8ssbXiAsJ-L0g,18434
+rollgate/dedup.py,sha256=N2B1KhFVdLL9epdNGoaSq1hDreJK8Cz3ed6Cbo678dE,4969
+rollgate/errors.py,sha256=C_Ib_mkCkttX6_7HlQ4S4EzigKiWqvTauGGeYFEFuEw,4267
+rollgate/evaluate.py,sha256=J1vnZB9EqfXMUeNZ9QKDtjo8bxbrXsuANnnlkNZlGmQ,10619
+rollgate/metrics.py,sha256=ByIyWeIL9Oc2YDkgIHQ2iq0xYRo4OTAY4nlvsdxOsGY,18911
+rollgate/reasons.py,sha256=uL21HpKshQP87iI2CAmzETKAG5X5fIbMeuPIWRTrydQ,3963
+rollgate/retry.py,sha256=L_pR8CbReBBNZ0Av6GydNB2EjKaXPdCbV0DggyWIptg,4448
+rollgate/tracing.py,sha256=q4XgH8v0MGBnFxYEG4WElS3K9O53b3IlbFqPiQl49Yc,11697
+rollgate-1.0.0.dist-info/METADATA,sha256=BfeAeu17uJWvunERFEnA4_IYFTfhTGNfRaCQFJz5CLc,8182
+rollgate-1.0.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+rollgate-1.0.0.dist-info/RECORD,,

rollgate-1.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any