amigo_sdk 0.1.1__py3-none-any.whl

amigo_sdk-0.1.1.dist-info/METADATA

@@ -0,0 +1,192 @@
+Metadata-Version: 2.4
+Name: amigo_sdk
+Version: 0.1.1
+Summary: Amigo AI Python SDK
+Author: Amigo AI
+License-File: LICENSE
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.9
+Requires-Dist: email-validator<3.0,>=2.0
+Requires-Dist: httpx<1.0,>=0.25
+Requires-Dist: pydantic-settings<3.0,>=2.0
+Requires-Dist: pydantic<3.0,>=2.7
+Provides-Extra: dev
+Requires-Dist: datamodel-code-generator[http]<1.0,>=0.21; extra == 'dev'
+Requires-Dist: pytest-asyncio<1.0,>=0.21; extra == 'dev'
+Requires-Dist: pytest-cov<6.0,>=4.0; extra == 'dev'
+Requires-Dist: pytest-httpx<1.0,>=0.30; extra == 'dev'
+Requires-Dist: pytest<9.0,>=7.0; extra == 'dev'
+Requires-Dist: python-dotenv<2.0,>=1.0; extra == 'dev'
+Requires-Dist: ruff<1.0,>=0.1; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Amigo Python SDK
+
+[![Tests](https://github.com/amigo-ai/amigo-python-sdk/actions/workflows/test.yml/badge.svg)](https://github.com/amigo-ai/amigo-python-sdk/actions/workflows/test.yml)
+[![codecov](https://codecov.io/gh/amigo-ai/amigo-python-sdk/graph/badge.svg?token=1A7KVPV9ZR)](https://codecov.io/gh/amigo-ai/amigo-python-sdk)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+The official Python SDK for the Amigo API, providing a simple and intuitive interface to interact with Amigo's AI services.
+
+## Installation
+
+Install the SDK using pip:
+
+```bash
+pip install amigo_sdk
+```
+
+Or add it to your requirements.txt:
+
+```txt
+amigo_sdk
+```
+
+### API compatibility
+
+This SDK auto-generates its types from the latest [Amigo OpenAPI schema](https://api.amigo.ai/v1/openapi.json). As a result, only the latest published SDK version is guaranteed to match the current API. If you pin to an older version, it may not include the newest endpoints or fields.
+
+## Quick Start
+
+```python
+import asyncio
+from amigo_sdk import AmigoClient
+from amigo_sdk.generated.model import GetConversationsParametersQuery
+
+# Initialize the client
+client = AmigoClient(
+    api_key="your-api-key",
+    api_key_id="your-api-key-id",
+    user_id="user-id",
+    org_id="your-organization-id",
+)
+
+# List recent conversations
+async def example():
+    try:
+        async with client:
+            conversations = await client.conversation.get_conversations(
+                GetConversationsParametersQuery(limit=10, sort_by=["-created_at"])
+            )
+            print("Conversations:", conversations)
+    except Exception as error:
+        print(error)
+
+# Run the example
+asyncio.run(example())
+```
+
+## Examples
+
+For more SDK usage examples see checkout the [examples/](examples/README.md) folder.
+
+## Configuration
+
+The SDK requires the following configuration parameters:
+
+| Parameter    | Type | Required | Description                                                    |
+| ------------ | ---- | -------- | -------------------------------------------------------------- |
+| `api_key`    | str  | ✅       | API key from Amigo dashboard                                   |
+| `api_key_id` | str  | ✅       | API key ID from Amigo dashboard                                |
+| `user_id`    | str  | ✅       | User ID on whose behalf the request is made                    |
+| `org_id`     | str  | ✅       | Your organization ID                                           |
+| `base_url`   | str  | ❌       | Base URL of the Amigo API (defaults to `https://api.amigo.ai`) |
+
+### Environment Variables
+
+You can also configure the SDK using environment variables:
+
+```bash
+export AMIGO_API_KEY="your-api-key"
+export AMIGO_API_KEY_ID="your-api-key-id"
+export AMIGO_USER_ID="user-id"
+export AMIGO_ORG_ID="your-organization-id"
+export AMIGO_BASE_URL="https://api.amigo.ai"  # optional
+```
+
+Then initialize the client without parameters:
+
+```python
+from amigo_sdk import AmigoClient
+
+# Automatically loads from environment variables
+client = AmigoClient()
+```
+
+### Using .env Files
+
+Create a `.env` file in your project root:
+
+```env
+AMIGO_API_KEY=your-api-key
+AMIGO_API_KEY_ID=your-api-key-id
+AMIGO_USER_ID=user-id
+AMIGO_ORG_ID=your-organization-id
+```
+
+The SDK will automatically load these variables.
+
+### Getting Your API Credentials
+
+1. **API Key & API Key ID**: Generate these from your Amigo admin dashboard or programmatically using the API
+2. **Organization ID**: Found in your Amigo dashboard URL or organization settings
+3. **User ID**: The ID of the user you want to impersonate for API calls
+
+For detailed instructions on generating API keys, see the [Authentication Guide](https://docs.amigo.ai/developer-guide).
+
+## Available Resources
+
+The SDK provides access to the following resources:
+
+- **Organizations**: Get Organization info
+- **Services**: Get available services
+- **Conversation**: Manage conversations
+- **User**: Manage users
+
+## Error Handling
+
+The SDK provides typed error handling:
+
+```python
+from amigo_sdk import AmigoClient
+from amigo_sdk.errors import (
+    AuthenticationError,
+    NotFoundError,
+    BadRequestError,
+    ValidationError
+)
+
+async def example_with_error_handling():
+    client = AmigoClient()
+
+    try:
+        async with client:
+            result = await client.organizations.get_organization("org-id")
+    except AuthenticationError as error:
+        print("Authentication failed:", error)
+    except NotFoundError as error:
+        print("Resource not found:", error)
+    except BadRequestError as error:
+        print("Bad request:", error)
+    except ValidationError as error:
+        print("Validation error:", error)
+    except Exception as error:
+        print("Unexpected error:", error)
+```
+
+## Development
+
+For detailed development setup, testing, and contribution guidelines, see [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## Documentation
+
+- **Developer Guide**: [https://docs.amigo.ai/developer-guide](https://docs.amigo.ai/developer-guide)
+- **API Reference**: [https://docs.amigo.ai/api-reference](https://docs.amigo.ai/api-reference)
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Support
+
+For questions, issues, or feature requests, please visit our [GitHub repository](https://github.com/amigo-ai/amigo-python-sdk) or contact support through the Amigo dashboard.

amigo_sdk-0.1.1.dist-info/RECORD

@@ -0,0 +1,16 @@
+amigo_sdk/__init__.py,sha256=rnObPjuBcEStqSO0S6gsdS_ot8ITOQjVj_-P1LUUYpg,22
+amigo_sdk/auth.py,sha256=Kvwk4P2HJaVUIn2Lwj7l6_xTm0IOVxMlthiXthm-V2Y,1029
+amigo_sdk/config.py,sha256=0eZIo-hcJ8ODftKAr-mwB-FGJxGO5PT5T4dRpyWPqAg,1491
+amigo_sdk/errors.py,sha256=RkRyF5eAASd8fIOS6YvL9rLDvLAYWqHfpHSCR7jqvl4,4840
+amigo_sdk/http_client.py,sha256=XDtcQnAXf4E46Kjl6tKVVFgrMgozjCbOcDf21aK_c4s,8843
+amigo_sdk/sdk_client.py,sha256=yLK8f0ARxLOlJX_cM-Y1GW-zCgJWsL2LIrWMxQGaMhY,3685
+amigo_sdk/generated/model.py,sha256=y8ztYgbnLVZSGAaw4uqTjOc0vLdJoTLMS8nthHBUMU8,427393
+amigo_sdk/resources/conversation.py,sha256=gRkZwqLGOscqoCFcagwU-NfTeMuvLsuEqN_uLyNu1NI,8514
+amigo_sdk/resources/organization.py,sha256=HNwUgeggeEklvcwFS7Of6nGDawN-_Uvd9NsXtcYg65o,726
+amigo_sdk/resources/service.py,sha256=DrKaLnKAglcCeZJQEw50hAOLWtW_InnOu551TxgwF60,947
+amigo_sdk/resources/user.py,sha256=Y66Eb5kH3sYWpdx1E9PP8slban8jpUHmig3YEXHaD_Y,2066
+amigo_sdk-0.1.1.dist-info/METADATA,sha256=jRSx4qhCeZeK76h92roVV_tHKDVf89vQdmqCE6ve15U,6215
+amigo_sdk-0.1.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+amigo_sdk-0.1.1.dist-info/entry_points.txt,sha256=ivKZ8S9W6SH796zUDHeM-qHodrwmkmUItophi-jJWK0,82
+amigo_sdk-0.1.1.dist-info/licenses/LICENSE,sha256=tx3FiTVbGxwBUOxQbNh05AAQlC2jd5hGvNpIkSfVbCo,1062
+amigo_sdk-0.1.1.dist-info/RECORD,,

amigo_sdk-0.1.1.dist-info/WHEEL

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

amigo_sdk-0.1.1.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+check = scripts.check:main
+gen-models = scripts.gen_models:main

amigo_sdk-0.1.1.dist-info/licenses/LICENSE

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