indoxrouter 0.1.0__tar.gz → 0.1.2__tar.gz

indoxrouter-0.1.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 indoxRouter Team
+
+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. 

indoxrouter-0.1.2/PKG-INFO

@@ -0,0 +1,259 @@
+Metadata-Version: 2.2
+Name: indoxrouter
+Version: 0.1.2
+Summary: A unified interface for various LLM providers
+Home-page: https://github.com/indoxrouter/indoxrouter
+Author: indoxRouter Team
+Author-email: ashkan.eskandari.dev@gmail.com
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+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
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.25.0
+Requires-Dist: openai>=1.0.0
+Requires-Dist: PyJWT>=2.0.0
+Requires-Dist: tiktoken>=0.4.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: isort>=5.0.0; extra == "dev"
+Requires-Dist: flake8>=6.0.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Provides-Extra: postgres
+Requires-Dist: psycopg2-binary>=2.9.5; extra == "postgres"
+Provides-Extra: all
+Requires-Dist: pytest>=7.0.0; extra == "all"
+Requires-Dist: pytest-cov>=4.0.0; extra == "all"
+Requires-Dist: black>=23.0.0; extra == "all"
+Requires-Dist: isort>=5.0.0; extra == "all"
+Requires-Dist: flake8>=6.0.0; extra == "all"
+Requires-Dist: mypy>=1.0.0; extra == "all"
+Requires-Dist: psycopg2-binary>=2.9.5; extra == "all"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# indoxRouter
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/indoxrouter/indoxrouter/main/docs/assets/logo.png" alt="indoxRouter Logo" width="200"/>
+</p>
+
+<p align="center">
+  <strong>A unified interface for various LLM providers</strong>
+</p>
+
+<p align="center">
+  <a href="https://pypi.org/project/indoxRouter/"><img src="https://img.shields.io/pypi/v/indoxRouter.svg" alt="PyPI version"></a>
+  <a href="https://github.com/indoxrouter/indoxrouter/blob/main/LICENSE"><img src="https://img.shields.io/github/license/indoxrouter/indoxrouter" alt="License"></a>
+  <a href="https://github.com/indoxrouter/indoxrouter/stargazers"><img src="https://img.shields.io/github/stars/indoxrouter/indoxrouter" alt="GitHub stars"></a>
+</p>
+
+## Overview
+
+indoxRouter is a powerful Python library that provides a unified interface to interact with various Large Language Model (LLM) providers. With a single API key, you can access models from OpenAI, Anthropic, Mistral, Google, and more, without having to manage multiple provider-specific API keys and implementations.
+
+### Key Features
+
+- **Single API for Multiple Providers**: Access models from OpenAI, Anthropic, Mistral, Google, and more with a single API key
+- **Standardized Response Format**: Consistent response format across all providers
+- **Streaming Support**: Stream responses for real-time applications
+- **Cost Tracking**: Track token usage and costs across providers
+- **Rate Limiting**: Built-in rate limiting to prevent exceeding provider quotas
+- **Error Handling**: Comprehensive error handling with detailed error messages
+- **Authentication**: Secure authentication with JWT tokens
+- **Type Hints**: Full type hints for better IDE support
+
+## Installation
+
+```bash
+pip install indoxRouter
+```
+
+For development:
+
+```bash
+pip install indoxRouter[dev]
+```
+
+## Quick Start
+
+```python
+from indoxRouter import Client
+from indoxRouter.models import ChatMessage
+
+# Initialize the client with your API key
+client = Client(api_key="your-api-key")
+
+# Chat completion with OpenAI
+response = client.chat(
+    messages=[
+        {"role": "user", "content": "What are three fun activities to do in New York?"}
+    ],
+    model="openai/gpt-4o-mini",
+    temperature=0.7,
+    max_tokens=500,
+)
+
+print(response.data)
+```
+
+## Available Providers
+
+indoxRouter supports the following providers:
+
+- OpenAI
+- Anthropic (Claude)
+- Mistral
+- Google
+- Cohere
+
+## Core Features
+
+### Chat Completion
+
+```python
+response = client.chat(
+    messages=[
+        {"role": "user", "content": "What are three fun activities to do in New York?"}
+    ],
+    model="openai/gpt-4o-mini",
+    temperature=0.7,
+    max_tokens=500,
+)
+```
+
+### Text Completion
+
+```python
+response = client.completion(
+    prompt="Write a short story about a robot learning to paint.",
+    model="anthropic/claude-3-haiku",
+    temperature=0.7,
+    max_tokens=500,
+)
+```
+
+### Embeddings
+
+```python
+response = client.embeddings(
+    text="This is a sample text to embed.",
+    model="openai/text-embedding-3-small",
+)
+```
+
+### Image Generation
+
+```python
+response = client.image(
+    prompt="A futuristic city with flying cars and neon lights",
+    model="openai/dall-e-3",
+    size="1024x1024",
+)
+```
+
+### Streaming
+
+```python
+generator = client.chat(
+    messages=[
+        {"role": "user", "content": "Write a short story about a robot learning to paint."}
+    ],
+    model="openai/gpt-4o-mini",
+    temperature=0.7,
+    max_tokens=500,
+    stream=True,
+    return_generator=True,
+)
+
+for chunk in generator:
+    if isinstance(chunk, dict) and chunk.get("is_usage_info"):
+        # This is the final usage info
+        usage_info = chunk
+    else:
+        # This is a content chunk
+        print(chunk, end="", flush=True)
+```
+
+## Provider and Model Information
+
+```python
+# List all available providers
+providers = client.providers()
+
+# List all available models
+models = client.models()
+
+# List models for a specific provider
+openai_models = client.models(provider="openai")
+
+# Get information about a specific model
+model_info = client.model_info(provider="openai", model="gpt-4o-mini")
+```
+
+## Configuration
+
+indoxRouter can be configured using environment variables or a configuration file:
+
+```python
+# Set API key via environment variable
+import os
+os.environ["INDOX_ROUTER_API_KEY"] = "your-api-key"
+
+# Or provide it directly to the client
+client = Client(api_key="your-api-key")
+```
+
+## Error Handling
+
+indoxRouter provides comprehensive error handling:
+
+```python
+from indoxRouter import Client
+from indoxRouter.exceptions import AuthenticationError, RateLimitError, ProviderError
+
+try:
+    client = Client(api_key="invalid-api-key")
+except AuthenticationError as e:
+    print(f"Authentication error: {e}")
+
+try:
+    response = client.chat(
+        messages=[{"role": "user", "content": "Hello"}],
+        model="nonexistent-model",
+    )
+except ProviderError as e:
+    print(f"Provider error: {e}")
+```
+
+## Documentation
+
+For detailed documentation, visit [https://docs.indoxrouter.com](https://docs.indoxrouter.com).
+
+## Examples
+
+Check out the [examples](https://github.com/indoxrouter/indoxrouter/tree/main/examples) directory for more examples.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

indoxrouter-0.1.2/README.md

@@ -0,0 +1,209 @@
+# indoxRouter
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/indoxrouter/indoxrouter/main/docs/assets/logo.png" alt="indoxRouter Logo" width="200"/>
+</p>
+
+<p align="center">
+  <strong>A unified interface for various LLM providers</strong>
+</p>
+
+<p align="center">
+  <a href="https://pypi.org/project/indoxRouter/"><img src="https://img.shields.io/pypi/v/indoxRouter.svg" alt="PyPI version"></a>
+  <a href="https://github.com/indoxrouter/indoxrouter/blob/main/LICENSE"><img src="https://img.shields.io/github/license/indoxrouter/indoxrouter" alt="License"></a>
+  <a href="https://github.com/indoxrouter/indoxrouter/stargazers"><img src="https://img.shields.io/github/stars/indoxrouter/indoxrouter" alt="GitHub stars"></a>
+</p>
+
+## Overview
+
+indoxRouter is a powerful Python library that provides a unified interface to interact with various Large Language Model (LLM) providers. With a single API key, you can access models from OpenAI, Anthropic, Mistral, Google, and more, without having to manage multiple provider-specific API keys and implementations.
+
+### Key Features
+
+- **Single API for Multiple Providers**: Access models from OpenAI, Anthropic, Mistral, Google, and more with a single API key
+- **Standardized Response Format**: Consistent response format across all providers
+- **Streaming Support**: Stream responses for real-time applications
+- **Cost Tracking**: Track token usage and costs across providers
+- **Rate Limiting**: Built-in rate limiting to prevent exceeding provider quotas
+- **Error Handling**: Comprehensive error handling with detailed error messages
+- **Authentication**: Secure authentication with JWT tokens
+- **Type Hints**: Full type hints for better IDE support
+
+## Installation
+
+```bash
+pip install indoxRouter
+```
+
+For development:
+
+```bash
+pip install indoxRouter[dev]
+```
+
+## Quick Start
+
+```python
+from indoxRouter import Client
+from indoxRouter.models import ChatMessage
+
+# Initialize the client with your API key
+client = Client(api_key="your-api-key")
+
+# Chat completion with OpenAI
+response = client.chat(
+    messages=[
+        {"role": "user", "content": "What are three fun activities to do in New York?"}
+    ],
+    model="openai/gpt-4o-mini",
+    temperature=0.7,
+    max_tokens=500,
+)
+
+print(response.data)
+```
+
+## Available Providers
+
+indoxRouter supports the following providers:
+
+- OpenAI
+- Anthropic (Claude)
+- Mistral
+- Google
+- Cohere
+
+## Core Features
+
+### Chat Completion
+
+```python
+response = client.chat(
+    messages=[
+        {"role": "user", "content": "What are three fun activities to do in New York?"}
+    ],
+    model="openai/gpt-4o-mini",
+    temperature=0.7,
+    max_tokens=500,
+)
+```
+
+### Text Completion
+
+```python
+response = client.completion(
+    prompt="Write a short story about a robot learning to paint.",
+    model="anthropic/claude-3-haiku",
+    temperature=0.7,
+    max_tokens=500,
+)
+```
+
+### Embeddings
+
+```python
+response = client.embeddings(
+    text="This is a sample text to embed.",
+    model="openai/text-embedding-3-small",
+)
+```
+
+### Image Generation
+
+```python
+response = client.image(
+    prompt="A futuristic city with flying cars and neon lights",
+    model="openai/dall-e-3",
+    size="1024x1024",
+)
+```
+
+### Streaming
+
+```python
+generator = client.chat(
+    messages=[
+        {"role": "user", "content": "Write a short story about a robot learning to paint."}
+    ],
+    model="openai/gpt-4o-mini",
+    temperature=0.7,
+    max_tokens=500,
+    stream=True,
+    return_generator=True,
+)
+
+for chunk in generator:
+    if isinstance(chunk, dict) and chunk.get("is_usage_info"):
+        # This is the final usage info
+        usage_info = chunk
+    else:
+        # This is a content chunk
+        print(chunk, end="", flush=True)
+```
+
+## Provider and Model Information
+
+```python
+# List all available providers
+providers = client.providers()
+
+# List all available models
+models = client.models()
+
+# List models for a specific provider
+openai_models = client.models(provider="openai")
+
+# Get information about a specific model
+model_info = client.model_info(provider="openai", model="gpt-4o-mini")
+```
+
+## Configuration
+
+indoxRouter can be configured using environment variables or a configuration file:
+
+```python
+# Set API key via environment variable
+import os
+os.environ["INDOX_ROUTER_API_KEY"] = "your-api-key"
+
+# Or provide it directly to the client
+client = Client(api_key="your-api-key")
+```
+
+## Error Handling
+
+indoxRouter provides comprehensive error handling:
+
+```python
+from indoxRouter import Client
+from indoxRouter.exceptions import AuthenticationError, RateLimitError, ProviderError
+
+try:
+    client = Client(api_key="invalid-api-key")
+except AuthenticationError as e:
+    print(f"Authentication error: {e}")
+
+try:
+    response = client.chat(
+        messages=[{"role": "user", "content": "Hello"}],
+        model="nonexistent-model",
+    )
+except ProviderError as e:
+    print(f"Provider error: {e}")
+```
+
+## Documentation
+
+For detailed documentation, visit [https://docs.indoxrouter.com](https://docs.indoxrouter.com).
+
+## Examples
+
+Check out the [examples](https://github.com/indoxrouter/indoxrouter/tree/main/examples) directory for more examples.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

indoxrouter-0.1.2/indoxRouter/__init__.py

@@ -0,0 +1,83 @@
+"""
+indoxRouter - A unified interface for various LLM providers.
+
+This package provides a simple and consistent way to interact with different
+LLM providers like OpenAI, Claude, Mistral, and more.
+"""
+
+__version__ = "0.1.0"
+
+from .client import Client, IndoxRouter
+from .config import Config, get_config
+from .models import (
+    ChatMessage,
+    ChatResponse,
+    CompletionResponse,
+    EmbeddingResponse,
+    ImageResponse,
+    ModelInfo,
+    Usage,
+)
+from .exceptions import (
+    IndoxRouterError,
+    AuthenticationError,
+    ProviderError,
+    ProviderNotFoundError,
+    ModelNotFoundError,
+    InvalidParametersError,
+    RequestError,
+)
+from .constants import (
+    DEFAULT_TEMPERATURE,
+    DEFAULT_MAX_TOKENS,
+    DEFAULT_TOP_P,
+    DEFAULT_FREQUENCY_PENALTY,
+    DEFAULT_PRESENCE_PENALTY,
+    DEFAULT_IMAGE_SIZE,
+    DEFAULT_IMAGE_COUNT,
+)
+from .utils import (
+    count_tokens,
+    calculate_cost,
+    format_timestamp,
+)
+
+__all__ = [
+    # Main client
+    "Client",
+    "IndoxRouter",
+    # Configuration
+    "Config",
+    "get_config",
+    # Database
+    "Database",
+    "get_database",
+    # Models
+    "ChatMessage",
+    "ChatResponse",
+    "CompletionResponse",
+    "EmbeddingResponse",
+    "ImageResponse",
+    "ModelInfo",
+    "Usage",
+    # Exceptions
+    "IndoxRouterError",
+    "AuthenticationError",
+    "ProviderError",
+    "ProviderNotFoundError",
+    "ModelNotFoundError",
+    "InvalidParametersError",
+    "RequestError",
+    # Constants
+    "DEFAULT_TEMPERATURE",
+    "DEFAULT_MAX_TOKENS",
+    "DEFAULT_TOP_P",
+    "DEFAULT_FREQUENCY_PENALTY",
+    "DEFAULT_PRESENCE_PENALTY",
+    "DEFAULT_IMAGE_SIZE",
+    "DEFAULT_IMAGE_COUNT",
+    # Utilities
+    "count_tokens",
+    "calculate_cost",
+    "format_timestamp",
+]