kinde-python-sdk 2.0.0b12__tar.gz → 2.0.0b14__tar.gz

{kinde_python_sdk-2.0.0b12/kinde_python_sdk.egg-info → kinde_python_sdk-2.0.0b14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kinde-python-sdk
-Version: 2.0.0b12
+Version: 2.0.0b14
 Summary: Connect your app to the Kinde platform
 Author-email: Kinde Engineering <engineering@kinde.com>
 Project-URL: Homepage, https://github.com/kinde-oss/kinde-python-sdk
@@ -47,126 +47,24 @@ You can also use the [Python starter kit here](https://github.com/kinde-starter-
 
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com) [![Kinde Docs](https://img.shields.io/badge/Kinde-Docs-eee?style=flat-square)](https://kinde.com/docs/developer-tools) [![Kinde Community](https://img.shields.io/badge/Kinde-Community-eee?style=flat-square)](https://thekindecommunity.slack.com)
 
-## Documentation
+## 🚨 Important: Migrating from v1?
 
-For details on integrating this SDK into your project, head over to the [Kinde docs](https://kinde.com/docs/) and see the [Python SDK](https://kinde.com/docs/developer-tools/python-sdk/) doc 👍🏼.
+If you're upgrading from Kinde Python SDK v1, **the API has changed significantly**. The `KindeClient` class has been completely replaced with `OAuth`.
 
-## Storage Usage Examples
-
-### Basic Usage
-```python
-from kinde_sdk.auth import OAuth
-from kinde_sdk.core.storage import StorageManager
-
-# Basic initialization via OAuth
-# This is the recommended way to initialize the storage system
-# OAuth automatically initializes the StorageManager with the provided config
-oauth = OAuth(
-    client_id="your_client_id",
-    client_secret="your_client_secret",
-    redirect_uri="your_redirect_uri"
-)
-
-# Direct access to the storage manager
-# This is safe to use after OAuth initialization
-storage_manager = StorageManager()
-
-# Store authentication data
-storage_manager.set("user_tokens", {
-    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
-    "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
-    "expires_at": 1678901234
-})
-
-# Retrieve tokens
-tokens = storage_manager.get("user_tokens")
-if tokens:
-    access_token = tokens.get("access_token")
-    # Use the access token for API requests
-    
-# Delete tokens when logging out
-storage_manager.delete("user_tokens")
-```
-
-### Using a Custom Storage Backend
-```python
-oauth = OAuth(
-    client_id="your_client_id",
-    storage_config={
-        "type": "local_storage",
-        "options": {
-            # backend-specific options
-        }
-    }
-)
-```
-
-### Handling Multi-Device Usage
-The StorageManager automatically assigns a unique device ID to each client instance, ensuring that
-the same user logged in on different devices won't experience session clashes. Keys are namespaced
-with the device ID by default.
-
-```python
-# Get the current device ID
-device_id = storage_manager.get_device_id()
-print(f"Current device ID: {device_id}")
-
-# Clear all data for the current device (useful for logout)
-storage_manager.clear_device_data()
-
-# For data that should be shared across all devices for the same user
-# Use the "user:" prefix
-storage_manager.set("user:shared_preferences", {"theme": "dark"})
-
-# For data that should be global across all users and devices
-# Use the "global:" prefix
-storage_manager.set("global:app_settings", {"version": "1.0.0"})
-```
-
-## Best Practices for Storage Management
-
-1. **Always initialize OAuth first**: The OAuth constructor initializes the StorageManager, so create your OAuth instance before accessing the storage.
-
-2. **Manual initialization (if needed)**: If you need to use StorageManager before creating an OAuth instance, explicitly initialize it first:
-```python
-# Manual initialization
-storage_manager = StorageManager()
-storage_manager.initialize({"type": "memory"})  # or your preferred storage config
-
-# You can also provide a specific device ID
-storage_manager.initialize(
-    config={"type": "memory"},
-    device_id="custom-device-identifier"
-)
-
-# Now safe to use
-storage_manager.set("some_key", {"some": "value"})
-```
-
-3. **Safe access pattern**: If you're unsure about initialization status, you can use this pattern:
-```python
-storage_manager = StorageManager()
-if not storage_manager._initialized:
-    storage_manager.initialize()
-    
-# Now safe to use
-data = storage_manager.get("some_key")
-```
-
-4. **Single configuration**: Configure the storage only once at application startup. Changing storage configuration mid-operation may lead to data inconsistency.
-
-5. **Access from anywhere**: After initialization, you can safely access the StorageManager from any part of your application without passing it around.
-
-6. **Device-specific data**: Understand that by default, data is stored with device-specific namespacing. To share data across devices, use the appropriate prefixes.
-
-7. **Complete logout**: To ensure all device-specific data is cleared during logout, call `storage_manager.clear_device_data()`.
+**📖 [Migration Guide](MIGRATION.md)** - Complete step-by-step migration instructions  
+**📋 [Quick Reference](QUICK_REFERENCE.md)** - At-a-glance v1 to v2 conversion table
 
+### Key Changes:
+- `KindeClient` → `OAuth` (main authentication class)
+- `client.get_flag()` → `await feature_flags.get_flag()` (feature flags)
+- `client.get_permission()` → `await permissions.get_permission()` (permissions)
+- Most operations are now asynchronous
 
+## Documentation
 
-# After initializing both OAuth and KindeApiClient use the following fn to get proper urls
-api_client.fetch_openid_configuration(oauth)
+For details on integrating this SDK into your project, head over to the [Kinde docs](https://kinde.com/docs/) and see the [Python SDK](https://kinde.com/docs/developer-tools/python-sdk/) doc 👍🏼.
 
-## Framework Integrations
+## Basic Usage: Framework Integrations
 
 The Kinde Python SDK provides seamless integration with popular Python web frameworks. Below are detailed guides for using Kinde with FastAPI and Flask.
 
@@ -329,10 +227,15 @@ For both FastAPI and Flask integrations:
 5. Implement proper session management
 6. Consider implementing CSRF protection
 
+After initializing both OAuth and KindeApiClient use the following fn to get proper urls:
+`api_client.fetch_openid_configuration(oauth)`
+
 # Kinde Management API Module
 
 This module provides a client for the Kinde Management API, allowing you to manage users, organizations, roles, permissions, and feature flags programmatically.
 
+> **Note for v1 users**: The Management API usage has changed in v2. See the [Migration Guide](MIGRATION.md) for details on the new `ManagementClient` class.
+
 ## Installation
 
 No additional installation is required if you already have the Kinde Python SDK installed. The Management API module is included as part of the SDK.
@@ -705,6 +608,122 @@ def main():
 if __name__ == "__main__":
     main()
 ```
+
+## Advanced Usage: Direct Storage Management
+
+This section covers direct interaction with the `StorageManager` for custom storage solutions.
+This is considered an advanced approach. For most use cases, the framework integrations provide sufficient storage handling.
+
+> **Note for v1 users**: Storage management has been completely redesigned in v2. See the [Migration Guide](MIGRATION.md) for details on the new storage abstraction layer.
+
+### Direct StorageManager Usage
+```python
+from kinde_sdk.auth import OAuth
+from kinde_sdk.core.storage import StorageManager
+
+# Basic initialization via OAuth
+# This is the recommended way to initialize the storage system
+# OAuth automatically initializes the StorageManager with the provided config
+oauth = OAuth(
+    client_id="your_client_id",
+    client_secret="your_client_secret",
+    redirect_uri="your_redirect_uri"
+)
+
+# Direct access to the storage manager
+# This is safe to use after OAuth initialization
+storage_manager = StorageManager()
+
+# Store authentication data
+storage_manager.set("user_tokens", {
+    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
+    "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
+    "expires_at": 1678901234
+})
+
+# Retrieve tokens
+tokens = storage_manager.get("user_tokens")
+if tokens:
+    access_token = tokens.get("access_token")
+    # Use the access token for API requests
+    
+# Delete tokens when logging out
+storage_manager.delete("user_tokens")
+```
+
+### Using a Custom Storage Backend
+```python
+oauth = OAuth(
+    client_id="your_client_id",
+    storage_config={
+        "type": "local_storage",
+        "options": {
+            # backend-specific options
+        }
+    }
+)
+```
+
+### Handling Multi-Device Usage
+The StorageManager automatically assigns a unique device ID to each client instance, ensuring that
+the same user logged in on different devices won't experience session clashes. Keys are namespaced
+with the device ID by default.
+
+```python
+# Get the current device ID
+device_id = storage_manager.get_device_id()
+print(f"Current device ID: {device_id}")
+
+# Clear all data for the current device (useful for logout)
+storage_manager.clear_device_data()
+
+# For data that should be shared across all devices for the same user
+# Use the "user:" prefix
+storage_manager.set("user:shared_preferences", {"theme": "dark"})
+
+# For data that should be global across all users and devices
+# Use the "global:" prefix
+storage_manager.set("global:app_settings", {"version": "1.0.0"})
+```
+
+### Best Practices for Storage Management
+
+1. **Always initialize OAuth first**: The OAuth constructor initializes the StorageManager, so create your OAuth instance before accessing the storage.
+
+2. **Manual initialization (if needed)**: If you need to use StorageManager before creating an OAuth instance, explicitly initialize it first:
+```python
+# Manual initialization
+storage_manager = StorageManager()
+storage_manager.initialize({"type": "memory"})  # or your preferred storage config
+
+# You can also provide a specific device ID
+storage_manager.initialize(
+    config={"type": "memory"},
+    device_id="custom-device-identifier"
+)
+
+# Now safe to use
+storage_manager.set("some_key", {"some": "value"})
+```
+
+3. **Safe access pattern**: If you're unsure about initialization status, you can use this pattern:
+```python
+storage_manager = StorageManager()
+if not storage_manager._initialized:
+    storage_manager.initialize()
+    
+# Now safe to use
+data = storage_manager.get("some_key")
+```
+
+4. **Single configuration**: Configure the storage only once at application startup. Changing storage configuration mid-operation may lead to data inconsistency.
+
+5. **Access from anywhere**: After initialization, you can safely access the StorageManager from any part of your application without passing it around.
+
+6. **Device-specific data**: Understand that by default, data is stored with device-specific namespacing. To share data across devices, use the appropriate prefixes.
+
+7. **Complete logout**: To ensure all device-specific data is cleared during logout, call `storage_manager.clear_device_data()`.
+
 # Version Tracking And Framework detection
 
 The implementation generates headers in the exact format specified:
@@ -731,6 +750,14 @@ Fallback: Uses "2.0.0-dev" during development
 
 The core team handles publishing.
 
+## Migration Support
+
+If you're upgrading from v1 of the Kinde Python SDK, we've prepared comprehensive migration resources:
+
+- **[Migration Guide](MIGRATION.md)** - Detailed step-by-step instructions for upgrading from v1 to v2
+- **[Quick Reference](QUICK_REFERENCE.md)** - At-a-glance conversion table for common v1 to v2 changes
+- **[Troubleshooting](MIGRATION.md#troubleshooting-common-issues)** - Solutions for common migration issues
+
 ## Contributing
 
 Please refer to Kinde's [contributing guidelines](https://github.com/kinde-oss/.github/blob/489e2ca9c3307c2b2e098a885e22f2239116394a/CONTRIBUTING.md).

{kinde_python_sdk-2.0.0b12 → kinde_python_sdk-2.0.0b14}/README.md

@@ -6,126 +6,24 @@ You can also use the [Python starter kit here](https://github.com/kinde-starter-
 
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com) [![Kinde Docs](https://img.shields.io/badge/Kinde-Docs-eee?style=flat-square)](https://kinde.com/docs/developer-tools) [![Kinde Community](https://img.shields.io/badge/Kinde-Community-eee?style=flat-square)](https://thekindecommunity.slack.com)
 
-## Documentation
+## 🚨 Important: Migrating from v1?
 
-For details on integrating this SDK into your project, head over to the [Kinde docs](https://kinde.com/docs/) and see the [Python SDK](https://kinde.com/docs/developer-tools/python-sdk/) doc 👍🏼.
+If you're upgrading from Kinde Python SDK v1, **the API has changed significantly**. The `KindeClient` class has been completely replaced with `OAuth`.
 
-## Storage Usage Examples
-
-### Basic Usage
-```python
-from kinde_sdk.auth import OAuth
-from kinde_sdk.core.storage import StorageManager
-
-# Basic initialization via OAuth
-# This is the recommended way to initialize the storage system
-# OAuth automatically initializes the StorageManager with the provided config
-oauth = OAuth(
-    client_id="your_client_id",
-    client_secret="your_client_secret",
-    redirect_uri="your_redirect_uri"
-)
-
-# Direct access to the storage manager
-# This is safe to use after OAuth initialization
-storage_manager = StorageManager()
-
-# Store authentication data
-storage_manager.set("user_tokens", {
-    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
-    "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
-    "expires_at": 1678901234
-})
-
-# Retrieve tokens
-tokens = storage_manager.get("user_tokens")
-if tokens:
-    access_token = tokens.get("access_token")
-    # Use the access token for API requests
-    
-# Delete tokens when logging out
-storage_manager.delete("user_tokens")
-```
-
-### Using a Custom Storage Backend
-```python
-oauth = OAuth(
-    client_id="your_client_id",
-    storage_config={
-        "type": "local_storage",
-        "options": {
-            # backend-specific options
-        }
-    }
-)
-```
-
-### Handling Multi-Device Usage
-The StorageManager automatically assigns a unique device ID to each client instance, ensuring that
-the same user logged in on different devices won't experience session clashes. Keys are namespaced
-with the device ID by default.
-
-```python
-# Get the current device ID
-device_id = storage_manager.get_device_id()
-print(f"Current device ID: {device_id}")
-
-# Clear all data for the current device (useful for logout)
-storage_manager.clear_device_data()
-
-# For data that should be shared across all devices for the same user
-# Use the "user:" prefix
-storage_manager.set("user:shared_preferences", {"theme": "dark"})
-
-# For data that should be global across all users and devices
-# Use the "global:" prefix
-storage_manager.set("global:app_settings", {"version": "1.0.0"})
-```
-
-## Best Practices for Storage Management
-
-1. **Always initialize OAuth first**: The OAuth constructor initializes the StorageManager, so create your OAuth instance before accessing the storage.
-
-2. **Manual initialization (if needed)**: If you need to use StorageManager before creating an OAuth instance, explicitly initialize it first:
-```python
-# Manual initialization
-storage_manager = StorageManager()
-storage_manager.initialize({"type": "memory"})  # or your preferred storage config
-
-# You can also provide a specific device ID
-storage_manager.initialize(
-    config={"type": "memory"},
-    device_id="custom-device-identifier"
-)
-
-# Now safe to use
-storage_manager.set("some_key", {"some": "value"})
-```
-
-3. **Safe access pattern**: If you're unsure about initialization status, you can use this pattern:
-```python
-storage_manager = StorageManager()
-if not storage_manager._initialized:
-    storage_manager.initialize()
-    
-# Now safe to use
-data = storage_manager.get("some_key")
-```
-
-4. **Single configuration**: Configure the storage only once at application startup. Changing storage configuration mid-operation may lead to data inconsistency.
-
-5. **Access from anywhere**: After initialization, you can safely access the StorageManager from any part of your application without passing it around.
-
-6. **Device-specific data**: Understand that by default, data is stored with device-specific namespacing. To share data across devices, use the appropriate prefixes.
-
-7. **Complete logout**: To ensure all device-specific data is cleared during logout, call `storage_manager.clear_device_data()`.
+**📖 [Migration Guide](MIGRATION.md)** - Complete step-by-step migration instructions  
+**📋 [Quick Reference](QUICK_REFERENCE.md)** - At-a-glance v1 to v2 conversion table
 
+### Key Changes:
+- `KindeClient` → `OAuth` (main authentication class)
+- `client.get_flag()` → `await feature_flags.get_flag()` (feature flags)
+- `client.get_permission()` → `await permissions.get_permission()` (permissions)
+- Most operations are now asynchronous
 
+## Documentation
 
-# After initializing both OAuth and KindeApiClient use the following fn to get proper urls
-api_client.fetch_openid_configuration(oauth)
+For details on integrating this SDK into your project, head over to the [Kinde docs](https://kinde.com/docs/) and see the [Python SDK](https://kinde.com/docs/developer-tools/python-sdk/) doc 👍🏼.
 
-## Framework Integrations
+## Basic Usage: Framework Integrations
 
 The Kinde Python SDK provides seamless integration with popular Python web frameworks. Below are detailed guides for using Kinde with FastAPI and Flask.
 
@@ -288,10 +186,15 @@ For both FastAPI and Flask integrations:
 5. Implement proper session management
 6. Consider implementing CSRF protection
 
+After initializing both OAuth and KindeApiClient use the following fn to get proper urls:
+`api_client.fetch_openid_configuration(oauth)`
+
 # Kinde Management API Module
 
 This module provides a client for the Kinde Management API, allowing you to manage users, organizations, roles, permissions, and feature flags programmatically.
 
+> **Note for v1 users**: The Management API usage has changed in v2. See the [Migration Guide](MIGRATION.md) for details on the new `ManagementClient` class.
+
 ## Installation
 
 No additional installation is required if you already have the Kinde Python SDK installed. The Management API module is included as part of the SDK.
@@ -664,6 +567,122 @@ def main():
 if __name__ == "__main__":
     main()
 ```
+
+## Advanced Usage: Direct Storage Management
+
+This section covers direct interaction with the `StorageManager` for custom storage solutions.
+This is considered an advanced approach. For most use cases, the framework integrations provide sufficient storage handling.
+
+> **Note for v1 users**: Storage management has been completely redesigned in v2. See the [Migration Guide](MIGRATION.md) for details on the new storage abstraction layer.
+
+### Direct StorageManager Usage
+```python
+from kinde_sdk.auth import OAuth
+from kinde_sdk.core.storage import StorageManager
+
+# Basic initialization via OAuth
+# This is the recommended way to initialize the storage system
+# OAuth automatically initializes the StorageManager with the provided config
+oauth = OAuth(
+    client_id="your_client_id",
+    client_secret="your_client_secret",
+    redirect_uri="your_redirect_uri"
+)
+
+# Direct access to the storage manager
+# This is safe to use after OAuth initialization
+storage_manager = StorageManager()
+
+# Store authentication data
+storage_manager.set("user_tokens", {
+    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
+    "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
+    "expires_at": 1678901234
+})
+
+# Retrieve tokens
+tokens = storage_manager.get("user_tokens")
+if tokens:
+    access_token = tokens.get("access_token")
+    # Use the access token for API requests
+    
+# Delete tokens when logging out
+storage_manager.delete("user_tokens")
+```
+
+### Using a Custom Storage Backend
+```python
+oauth = OAuth(
+    client_id="your_client_id",
+    storage_config={
+        "type": "local_storage",
+        "options": {
+            # backend-specific options
+        }
+    }
+)
+```
+
+### Handling Multi-Device Usage
+The StorageManager automatically assigns a unique device ID to each client instance, ensuring that
+the same user logged in on different devices won't experience session clashes. Keys are namespaced
+with the device ID by default.
+
+```python
+# Get the current device ID
+device_id = storage_manager.get_device_id()
+print(f"Current device ID: {device_id}")
+
+# Clear all data for the current device (useful for logout)
+storage_manager.clear_device_data()
+
+# For data that should be shared across all devices for the same user
+# Use the "user:" prefix
+storage_manager.set("user:shared_preferences", {"theme": "dark"})
+
+# For data that should be global across all users and devices
+# Use the "global:" prefix
+storage_manager.set("global:app_settings", {"version": "1.0.0"})
+```
+
+### Best Practices for Storage Management
+
+1. **Always initialize OAuth first**: The OAuth constructor initializes the StorageManager, so create your OAuth instance before accessing the storage.
+
+2. **Manual initialization (if needed)**: If you need to use StorageManager before creating an OAuth instance, explicitly initialize it first:
+```python
+# Manual initialization
+storage_manager = StorageManager()
+storage_manager.initialize({"type": "memory"})  # or your preferred storage config
+
+# You can also provide a specific device ID
+storage_manager.initialize(
+    config={"type": "memory"},
+    device_id="custom-device-identifier"
+)
+
+# Now safe to use
+storage_manager.set("some_key", {"some": "value"})
+```
+
+3. **Safe access pattern**: If you're unsure about initialization status, you can use this pattern:
+```python
+storage_manager = StorageManager()
+if not storage_manager._initialized:
+    storage_manager.initialize()
+    
+# Now safe to use
+data = storage_manager.get("some_key")
+```
+
+4. **Single configuration**: Configure the storage only once at application startup. Changing storage configuration mid-operation may lead to data inconsistency.
+
+5. **Access from anywhere**: After initialization, you can safely access the StorageManager from any part of your application without passing it around.
+
+6. **Device-specific data**: Understand that by default, data is stored with device-specific namespacing. To share data across devices, use the appropriate prefixes.
+
+7. **Complete logout**: To ensure all device-specific data is cleared during logout, call `storage_manager.clear_device_data()`.
+
 # Version Tracking And Framework detection
 
 The implementation generates headers in the exact format specified:
@@ -690,6 +709,14 @@ Fallback: Uses "2.0.0-dev" during development
 
 The core team handles publishing.
 
+## Migration Support
+
+If you're upgrading from v1 of the Kinde Python SDK, we've prepared comprehensive migration resources:
+
+- **[Migration Guide](MIGRATION.md)** - Detailed step-by-step instructions for upgrading from v1 to v2
+- **[Quick Reference](QUICK_REFERENCE.md)** - At-a-glance conversion table for common v1 to v2 changes
+- **[Troubleshooting](MIGRATION.md#troubleshooting-common-issues)** - Solutions for common migration issues
+
 ## Contributing
 
 Please refer to Kinde's [contributing guidelines](https://github.com/kinde-oss/.github/blob/489e2ca9c3307c2b2e098a885e22f2239116394a/CONTRIBUTING.md).