indoxrouter 0.1.25__py3-none-any.whl → 0.1.27__py3-none-any.whl

indoxrouter/constants.py

@@ -1,38 +1,38 @@
-"""
-Constants for the IndoxRouter client.
-"""
-
-# API settings
-DEFAULT_API_VERSION = "v1"
-DEFAULT_BASE_URL = "https://api.indoxrouter.com"  # Production server URL with HTTPS
-# DEFAULT_BASE_URL = "http://localhost:8000"  # Local development server
-DEFAULT_TIMEOUT = 60
-USE_COOKIES = True  # Always use cookie-based authentication
-
-# Default models
-DEFAULT_MODEL = "openai/gpt-4o-mini"
-DEFAULT_EMBEDDING_MODEL = "openai/text-embedding-3-small"
-DEFAULT_IMAGE_MODEL = "openai/dall-e-3"
-DEFAULT_TTS_MODEL = "openai/tts-1"
-GOOGLE_IMAGE_MODEL = "google/imagen-3.0-generate-002"
-XAI_IMAGE_MODEL = "xai/grok-2-image"
-XAI_IMAGE_LATEST_MODEL = "xai/grok-2-image-latest"
-XAI_IMAGE_SPECIFIC_MODEL = "xai/grok-2-image-1212"
-
-# API endpoints
-CHAT_ENDPOINT = "chat/completions"
-COMPLETION_ENDPOINT = "completions"
-EMBEDDING_ENDPOINT = "embeddings"
-IMAGE_ENDPOINT = "images/generations"
-TTS_ENDPOINT = "tts/generations"
-MODEL_ENDPOINT = "models"
-USAGE_ENDPOINT = "user/usage"
-
-# Error messages
-ERROR_INVALID_API_KEY = "API key must be provided either as an argument or as the INDOXROUTER_API_KEY environment variable"
-ERROR_NETWORK = "Network error occurred while communicating with the IndoxRouter API"
-ERROR_RATE_LIMIT = "Rate limit exceeded for the IndoxRouter API"
-ERROR_PROVIDER_NOT_FOUND = "Provider not found"
-ERROR_MODEL_NOT_FOUND = "Model not found"
-ERROR_INVALID_PARAMETERS = "Invalid parameters provided"
-ERROR_INSUFFICIENT_CREDITS = "Insufficient credits"
+"""
+Constants for the IndoxRouter client.
+"""
+
+# API settings
+DEFAULT_API_VERSION = "v1"
+DEFAULT_BASE_URL = "https://api.indoxrouter.com"  # Production server URL with HTTPS
+# DEFAULT_BASE_URL = "http://localhost:8000"  # Local development server
+DEFAULT_TIMEOUT = 60
+USE_COOKIES = True  # Always use cookie-based authentication
+
+# Default models
+DEFAULT_MODEL = "openai/gpt-4o-mini"
+DEFAULT_EMBEDDING_MODEL = "openai/text-embedding-3-small"
+DEFAULT_IMAGE_MODEL = "openai/dall-e-3"
+DEFAULT_TTS_MODEL = "openai/tts-1"
+GOOGLE_IMAGE_MODEL = "google/imagen-3.0-generate-002"
+XAI_IMAGE_MODEL = "xai/grok-2-image"
+XAI_IMAGE_LATEST_MODEL = "xai/grok-2-image-latest"
+XAI_IMAGE_SPECIFIC_MODEL = "xai/grok-2-image-1212"
+
+# API endpoints
+CHAT_ENDPOINT = "chat/completions"
+COMPLETION_ENDPOINT = "completions"
+EMBEDDING_ENDPOINT = "embeddings"
+IMAGE_ENDPOINT = "images/generations"
+TTS_ENDPOINT = "tts/generations"
+MODEL_ENDPOINT = "models"
+USAGE_ENDPOINT = "user/usage"
+
+# Error messages
+ERROR_INVALID_API_KEY = "API key must be provided either as an argument or as the INDOXROUTER_API_KEY environment variable"
+ERROR_NETWORK = "Network error occurred while communicating with the IndoxRouter API"
+ERROR_RATE_LIMIT = "Rate limit exceeded for the IndoxRouter API"
+ERROR_PROVIDER_NOT_FOUND = "Provider not found"
+ERROR_MODEL_NOT_FOUND = "Model not found"
+ERROR_INVALID_PARAMETERS = "Invalid parameters provided"
+ERROR_INSUFFICIENT_CREDITS = "Insufficient credits"

indoxrouter/exceptions.py

@@ -1,86 +1,86 @@
-"""
-Exceptions for the IndoxRouter client.
-"""
-
-from datetime import datetime
-from typing import Optional
-
-
-class IndoxRouterError(Exception):
-    """Base exception for all IndoxRouter errors."""
-
-    pass
-
-
-class AuthenticationError(IndoxRouterError):
-    """Raised when authentication fails."""
-
-    pass
-
-
-class NetworkError(IndoxRouterError):
-    """Raised when a network error occurs."""
-
-    pass
-
-
-class RateLimitError(IndoxRouterError):
-    """Raised when rate limits are exceeded."""
-
-    def __init__(self, message: str, reset_time: Optional[datetime] = None):
-        super().__init__(message)
-        self.reset_time = reset_time
-
-
-class ProviderError(IndoxRouterError):
-    """Raised when a provider returns an error."""
-
-    pass
-
-
-class ProviderNotFoundError(ProviderError):
-    """Raised when a requested provider is not found."""
-
-    pass
-
-
-class ModelNotFoundError(ProviderError):
-    """Raised when a requested model is not found."""
-
-    pass
-
-
-class ModelNotAvailableError(ProviderError):
-    """Raised when a model is disabled or not supported by the provider."""
-
-    pass
-
-
-class InvalidParametersError(IndoxRouterError):
-    """Raised when invalid parameters are provided."""
-
-    pass
-
-
-class RequestError(IndoxRouterError):
-    """Raised when a request to a provider fails."""
-
-    pass
-
-
-class InsufficientCreditsError(IndoxRouterError):
-    """Raised when the user doesn't have enough credits."""
-
-    pass
-
-
-class ValidationError(IndoxRouterError):
-    """Raised when request validation fails."""
-
-    pass
-
-
-class APIError(IndoxRouterError):
-    """Raised when the API returns an error."""
-
-    pass
+"""
+Exceptions for the IndoxRouter client.
+"""
+
+from datetime import datetime
+from typing import Optional
+
+
+class IndoxRouterError(Exception):
+    """Base exception for all IndoxRouter errors."""
+
+    pass
+
+
+class AuthenticationError(IndoxRouterError):
+    """Raised when authentication fails."""
+
+    pass
+
+
+class NetworkError(IndoxRouterError):
+    """Raised when a network error occurs."""
+
+    pass
+
+
+class RateLimitError(IndoxRouterError):
+    """Raised when rate limits are exceeded."""
+
+    def __init__(self, message: str, reset_time: Optional[datetime] = None):
+        super().__init__(message)
+        self.reset_time = reset_time
+
+
+class ProviderError(IndoxRouterError):
+    """Raised when a provider returns an error."""
+
+    pass
+
+
+class ProviderNotFoundError(ProviderError):
+    """Raised when a requested provider is not found."""
+
+    pass
+
+
+class ModelNotFoundError(ProviderError):
+    """Raised when a requested model is not found."""
+
+    pass
+
+
+class ModelNotAvailableError(ProviderError):
+    """Raised when a model is disabled or not supported by the provider."""
+
+    pass
+
+
+class InvalidParametersError(IndoxRouterError):
+    """Raised when invalid parameters are provided."""
+
+    pass
+
+
+class RequestError(IndoxRouterError):
+    """Raised when a request to a provider fails."""
+
+    pass
+
+
+class InsufficientCreditsError(IndoxRouterError):
+    """Raised when the user doesn't have enough credits."""
+
+    pass
+
+
+class ValidationError(IndoxRouterError):
+    """Raised when request validation fails."""
+
+    pass
+
+
+class APIError(IndoxRouterError):
+    """Raised when the API returns an error."""
+
+    pass

{indoxrouter-0.1.25.dist-info → indoxrouter-0.1.27.dist-info}/METADATA

@@ -1,179 +1,208 @@
-Metadata-Version: 2.4
-Name: indoxrouter
-Version: 0.1.25
-Summary: A unified client for various AI providers
-Author-email: indoxRouter Team <ashkan.eskandari.dev@gmail.com>
-License: MIT
-Project-URL: Homepage, https://github.com/indoxrouter/indoxrouter
-Project-URL: Repository, https://github.com/indoxrouter/indoxrouter
-Project-URL: Issues, https://github.com/indoxrouter/indoxrouter/issues
-Keywords: ai,api,client,openai,anthropic,google,mistral,xai,imagen,grok,image-generation,text-to-speech,tts,audio
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Developers
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: requests>=2.25.0
-Requires-Dist: python-dotenv>=1.0.0
-Dynamic: license-file
-
-# IndoxRouter
-
-A unified client for various AI providers, including OpenAI, anthropic, Google, and Mistral.
-
-## Features
-
-- **Unified API**: Access multiple AI providers through a single API
-- **Simple Interface**: Easy-to-use methods for chat, completion, embeddings, image generation, and text-to-speech
-- **Error Handling**: Standardized error handling across providers
-- **Authentication**: Secure cookie-based authentication
-
-## Installation
-
-```bash
-pip install indoxrouter
-```
-
-## Usage
-
-### Initialization
-
-```python
-from indoxrouter import Client
-
-# Initialize with API key
-client = Client(api_key="your_api_key")
-
-# Using environment variables
-# Set INDOX_ROUTER_API_KEY environment variable
-import os
-os.environ["INDOX_ROUTER_API_KEY"] = "your_api_key"
-client = Client()
-```
-
-### Authentication
-
-IndoxRouter uses cookie-based authentication with JWT tokens. The client handles this automatically by:
-
-1. Taking your API key and exchanging it for JWT tokens using the server's authentication endpoints
-2. Storing the JWT tokens in cookies
-3. Using the cookies for subsequent requests
-4. Automatically refreshing tokens when they expire
-
-```python
-# Authentication is handled automatically when creating the client
-client = Client(api_key="your_api_key")
-```
-
-### Chat Completions
-
-```python
-response = client.chat(
-    messages=[
-        {"role": "system", "content": "You are a helpful assistant."},
-        {"role": "user", "content": "Tell me a joke."}
-    ],
-    model="openai/gpt-4o-mini",  # Provider/model format
-    temperature=0.7
-)
-
-print(response["data"])
-```
-
-### Text Completions
-
-```python
-response = client.completion(
-    prompt="Once upon a time,",
-    model="openai/gpt-4o-mini",
-    max_tokens=100
-)
-
-print(response["data"])
-```
-
-### Embeddings
-
-```python
-response = client.embeddings(
-    text=["Hello world", "AI is amazing"],
-    model="openai/text-embedding-3-small"
-)
-
-print(f"Dimensions: {len(response['data'][0]['embedding'])}")
-print(f"First embedding: {response['data'][0]['embedding'][:5]}...")
-```
-
-### Image Generation
-
-```python
-# OpenAI Image Generation
-response = client.images(
-    prompt="A serene landscape with mountains and a lake",
-    model="openai/dall-e-3",
-    size="1024x1024",
-    quality="standard",  # Options: standard, hd
-    style="vivid"  # Options: vivid, natural
-)
-
-print(f"Image URL: {response['data'][0]['url']}")
-
-
-# Access base64 encoded image data
-if "b64_json" in response["data"][0]:
-    b64_data = response["data"][0]["b64_json"]
-    # Use the base64 data (e.g., to display in HTML or save to file)
-```
-
-### Text-to-Speech
-
-```python
-# Generate audio from text
-response = client.text_to_speech(
-    input="Hello, welcome to IndoxRouter!",
-    model="openai/tts-1",
-    voice="alloy",  # Options: alloy, echo, fable, onyx, nova, shimmer
-    response_format="mp3",  # Options: mp3, opus, aac, flac
-    speed=1.0  # Range: 0.25 to 4.0
-)
-
-print(f"Audio generated successfully: {response['success']}")
-print(f"Audio data available: {'data' in response}")
-```
-
-### Streaming Responses
-
-```python
-for chunk in client.chat(
-    messages=[{"role": "user", "content": "Write a short story."}],
-    model="openai/gpt-4o-mini",
-    stream=True
-):
-    if chunk.choices[0].delta.content:
-        print(chunk.choices[0].delta.content, end="", flush=True)
-```
-
-### Getting Available Models
-
-```python
-# Get all providers and models
-providers = client.models()
-for provider in providers:
-    print(f"Provider: {provider['name']}")
-    for model in provider["models"]:
-        print(f"  - {model['id']}: {model['description'] or ''}")
-
-# Get models for a specific provider
-openai_provider = client.models("openai")
-print(f"OpenAI models: {[m['id'] for m in openai_provider['models']]}")
-```
-
-## License
-
-This project is licensed under the MIT License - see the LICENSE file for details.
+Metadata-Version: 2.4
+Name: indoxrouter
+Version: 0.1.27
+Summary: A unified client for various AI providers
+Author-email: indoxRouter Team <ashkan.eskandari.dev@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/indoxrouter/indoxrouter
+Project-URL: Repository, https://github.com/indoxrouter/indoxrouter
+Project-URL: Issues, https://github.com/indoxrouter/indoxrouter/issues
+Keywords: ai,api,client,openai,anthropic,google,mistral,xai,imagen,grok,image-generation,text-to-speech,tts,audio
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.25.0
+Requires-Dist: python-dotenv>=1.0.0
+Dynamic: license-file
+
+# IndoxRouter
+
+A unified client for various AI providers, including OpenAI, anthropic, Google, and Mistral.
+
+## Features
+
+- **Unified API**: Access multiple AI providers through a single API
+- **Simple Interface**: Easy-to-use methods for chat, completion, embeddings, image generation, and text-to-speech
+- **Error Handling**: Standardized error handling across providers
+- **Authentication**: Secure cookie-based authentication
+- **BYOK Support**: Bring Your Own Key support for using your own provider API keys
+
+## Installation
+
+```bash
+pip install indoxrouter
+```
+
+## Usage
+
+### Initialization
+
+```python
+from indoxrouter import Client
+
+# Initialize with API key
+client = Client(api_key="your_api_key")
+
+# Using environment variables
+# Set INDOX_ROUTER_API_KEY environment variable
+import os
+os.environ["INDOX_ROUTER_API_KEY"] = "your_api_key"
+client = Client()
+```
+
+### Authentication
+
+IndoxRouter uses cookie-based authentication with JWT tokens. The client handles this automatically by:
+
+1. Taking your API key and exchanging it for JWT tokens using the server's authentication endpoints
+2. Storing the JWT tokens in cookies
+3. Using the cookies for subsequent requests
+4. Automatically refreshing tokens when they expire
+
+```python
+# Authentication is handled automatically when creating the client
+client = Client(api_key="your_api_key")
+```
+
+### Chat Completions
+
+```python
+response = client.chat(
+    messages=[
+        {"role": "system", "content": "You are a helpful assistant."},
+        {"role": "user", "content": "Tell me a joke."}
+    ],
+    model="openai/gpt-4o-mini",  # Provider/model format
+    temperature=0.7
+)
+
+print(response["data"])
+```
+
+### Text Completions
+
+```python
+response = client.completion(
+    prompt="Once upon a time,",
+    model="openai/gpt-4o-mini",
+    max_tokens=100
+)
+
+print(response["data"])
+```
+
+### Embeddings
+
+```python
+response = client.embeddings(
+    text=["Hello world", "AI is amazing"],
+    model="openai/text-embedding-3-small"
+)
+
+print(f"Dimensions: {len(response['data'][0]['embedding'])}")
+print(f"First embedding: {response['data'][0]['embedding'][:5]}...")
+```
+
+### Image Generation
+
+```python
+# OpenAI Image Generation
+response = client.images(
+    prompt="A serene landscape with mountains and a lake",
+    model="openai/dall-e-3",
+    size="1024x1024",
+    quality="standard",  # Options: standard, hd
+    style="vivid"  # Options: vivid, natural
+)
+
+print(f"Image URL: {response['data'][0]['url']}")
+
+
+# Access base64 encoded image data
+if "b64_json" in response["data"][0]:
+    b64_data = response["data"][0]["b64_json"]
+    # Use the base64 data (e.g., to display in HTML or save to file)
+```
+
+### BYOK (Bring Your Own Key) Support
+
+IndoxRouter supports BYOK, allowing you to use your own API keys for AI providers:
+
+```python
+# Use your own OpenAI API key
+response = client.chat(
+    messages=[{"role": "user", "content": "Hello!"}],
+    model="openai/gpt-4",
+    byok_api_key="sk-your-openai-key-here"
+)
+
+# Use your own Google API key for image generation
+response = client.images(
+    prompt="A beautiful sunset",
+    model="google/imagen-3.0-generate-002",
+    aspect_ratio="16:9",
+    byok_api_key="your-google-api-key-here"
+)
+```
+
+**BYOK Benefits:**
+
+- No credit deduction from your IndoxRouter account
+- No platform rate limiting
+- Direct provider access with your own API keys
+- Cost control - pay providers directly at their rates
+
+### Text-to-Speech
+
+```python
+# Generate audio from text
+response = client.text_to_speech(
+    input="Hello, welcome to IndoxRouter!",
+    model="openai/tts-1",
+    voice="alloy",  # Options: alloy, echo, fable, onyx, nova, shimmer
+    response_format="mp3",  # Options: mp3, opus, aac, flac
+    speed=1.0  # Range: 0.25 to 4.0
+)
+
+print(f"Audio generated successfully: {response['success']}")
+print(f"Audio data available: {'data' in response}")
+```
+
+### Streaming Responses
+
+```python
+for chunk in client.chat(
+    messages=[{"role": "user", "content": "Write a short story."}],
+    model="openai/gpt-4o-mini",
+    stream=True
+):
+    if chunk.choices[0].delta.content:
+        print(chunk.choices[0].delta.content, end="", flush=True)
+```
+
+### Getting Available Models
+
+```python
+# Get all providers and models
+providers = client.models()
+for provider in providers:
+    print(f"Provider: {provider['name']}")
+    for model in provider["models"]:
+        print(f"  - {model['id']}: {model['description'] or ''}")
+
+# Get models for a specific provider
+openai_provider = client.models("openai")
+print(f"OpenAI models: {[m['id'] for m in openai_provider['models']]}")
+```
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.

indoxrouter-0.1.27.dist-info/RECORD

@@ -0,0 +1,9 @@
+indoxrouter/__init__.py,sha256=P_2eiiAi-DrkkeeJndQdEMqnVheWzOZIjWkDayrwxuk,1561
+indoxrouter/client.py,sha256=AirPauY2kFqpR46LWOtDBKs--_9ilFTc2RQHb7vsLnM,45694
+indoxrouter/constants.py,sha256=HqTXfNpL_UvWsR5mod8YZgWOs1W6x6itr1BSbmyYEHY,1451
+indoxrouter/exceptions.py,sha256=cGlXNF8dd4X8UBWgxTA099nRhEkIjcqE_4iGOlIVVp8,1632
+indoxrouter-0.1.27.dist-info/licenses/LICENSE,sha256=5n28CfoynFakg-QJIHnecEXcveN8gq-ZwhC0h7ATse0,24232
+indoxrouter-0.1.27.dist-info/METADATA,sha256=5bZ0cAhmLFMuRP8h_5uNOEPwu39xjIqUaT_6CEjyi_k,5740
+indoxrouter-0.1.27.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+indoxrouter-0.1.27.dist-info/top_level.txt,sha256=v6FGWkw0QAnXhyYtnXLI1cxzna0iveNvZUotVzCWabM,12
+indoxrouter-0.1.27.dist-info/RECORD,,