amigo_sdk 0.1.1__tar.gz

amigo_sdk-0.1.1/.github/workflows/release.yml

@@ -0,0 +1,175 @@
+name: Release
+
+on:
+  workflow_dispatch:
+    inputs:
+      version_type:
+        description: "Version increment type"
+        required: true
+        default: "patch"
+        type: choice
+        options:
+          - patch
+          - minor
+          - major
+      dry_run:
+        description: "Dry run (skip upload)"
+        required: false
+        default: false
+        type: boolean
+
+permissions:
+  contents: write
+
+jobs:
+  # Reuse the existing test workflow
+  test:
+    uses: ./.github/workflows/test.yml
+    with:
+      skip_codecov: true
+    secrets: inherit
+
+  release:
+    runs-on: ubuntu-latest
+    needs: test
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          # Fetch full history for version tagging
+          fetch-depth: 0
+          # Use a token that can push tags and create releases
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+          cache: "pip"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+          pip install hatch
+
+      - name: Configure git
+        run: |
+          git config --global user.name "github-actions[bot]"
+          git config --global user.email "github-actions[bot]@users.noreply.github.com"
+
+      - name: Get current version
+        id: current_version
+        run: |
+          CURRENT_VERSION=$(hatch version)
+          echo "version=$CURRENT_VERSION" >> $GITHUB_OUTPUT
+          echo "Current version: $CURRENT_VERSION"
+
+      - name: Generate models
+        run: |
+          echo "🔄 Generating models from API spec..."
+          python -m scripts.gen_models
+          echo "✅ Models generated successfully"
+
+      - name: Increment version
+        id: new_version
+        run: |
+          echo "🔄 Incrementing ${{ inputs.version_type }} version..."
+          hatch version ${{ inputs.version_type }}
+          NEW_VERSION=$(hatch version)
+          echo "version=$NEW_VERSION" >> $GITHUB_OUTPUT
+          echo "✅ Version updated: ${{ steps.current_version.outputs.version }} → $NEW_VERSION"
+
+      - name: Build package
+        run: |
+          echo "🔄 Building package..."
+          # Clean any existing build artifacts
+          rm -rf dist/
+          hatch build
+          echo "✅ Package built successfully"
+          ls -la dist/
+
+      - name: Upload to PyPI
+        if: ${{ !inputs.dry_run }}
+        env:
+          HATCH_INDEX_USER: __token__
+          HATCH_INDEX_AUTH: ${{ secrets.PYPI_API_TOKEN }}
+        run: |
+          echo "🔄 Uploading to PyPI..."
+          hatch publish --repo https://upload.pypi.org/legacy/
+          echo "✅ Package uploaded to PyPI"
+
+      - name: Commit version bump
+        if: ${{ !inputs.dry_run }}
+        run: |
+          git add src/amigo_sdk/__init__.py
+          git commit -m "Bump version to ${{ steps.new_version.outputs.version }}"
+          git push origin HEAD
+
+      - name: Create and push tag
+        if: ${{ !inputs.dry_run }}
+        run: |
+          git tag -a "v${{ steps.new_version.outputs.version }}" -m "Release v${{ steps.new_version.outputs.version }}"
+          git push origin "v${{ steps.new_version.outputs.version }}"
+
+      - name: Create GitHub Release
+        if: ${{ !inputs.dry_run }}
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: "v${{ steps.new_version.outputs.version }}"
+          release_name: "Release v${{ steps.new_version.outputs.version }}"
+          body: |
+            ## Changes in v${{ steps.new_version.outputs.version }}
+
+            This release was automatically created by the GitHub Actions release workflow.
+
+            ### Package Information
+            - **Version**: ${{ steps.new_version.outputs.version }}
+            - **Target**: PyPI
+            - **Type**: ${{ inputs.version_type }} release
+
+            ### Links
+            ${{ format('- [View on PyPI](https://pypi.org/project/amigo_sdk/{0}/)', steps.new_version.outputs.version) }}
+
+            ### Installation
+            ```bash
+            pip install amigo_sdk
+            ```
+          draft: false
+
+      - name: Upload build artifacts
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist-${{ steps.new_version.outputs.version }}
+          path: dist/
+          retention-days: 30
+
+      - name: Release Summary
+        run: |
+          echo "## 🎉 Release Summary" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo "- **Version**: ${{ steps.new_version.outputs.version }}" >> $GITHUB_STEP_SUMMARY
+          echo "- **Previous**: ${{ steps.current_version.outputs.version }}" >> $GITHUB_STEP_SUMMARY
+          echo "- **Type**: ${{ inputs.version_type }} release" >> $GITHUB_STEP_SUMMARY
+          echo "- **Target**: PyPI" >> $GITHUB_STEP_SUMMARY
+          echo "- **Dry Run**: ${{ inputs.dry_run }}" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+
+          if [ "${{ inputs.dry_run }}" = "false" ]; then
+            echo "### 📦 Package Links" >> $GITHUB_STEP_SUMMARY
+            echo "- [PyPI Package](https://pypi.org/project/amigo_sdk/${{ steps.new_version.outputs.version }}/)" >> $GITHUB_STEP_SUMMARY
+            echo "- [GitHub Release](https://github.com/${{ github.repository }}/releases/tag/v${{ steps.new_version.outputs.version }})" >> $GITHUB_STEP_SUMMARY
+            echo "" >> $GITHUB_STEP_SUMMARY
+            echo "### 🚀 Next Steps" >> $GITHUB_STEP_SUMMARY
+            echo "The package has been successfully released and is available for installation!" >> $GITHUB_STEP_SUMMARY
+          else
+            echo "### 🚫 Dry Run Results" >> $GITHUB_STEP_SUMMARY
+            echo "- All steps completed successfully" >> $GITHUB_STEP_SUMMARY
+            echo "- Version would be bumped to: ${{ steps.new_version.outputs.version }}" >> $GITHUB_STEP_SUMMARY
+            echo "- Package built and ready for upload" >> $GITHUB_STEP_SUMMARY
+            echo "- No commits, tags, or uploads were made" >> $GITHUB_STEP_SUMMARY
+          fi

amigo_sdk-0.1.1/.github/workflows/test.yml

@@ -0,0 +1,50 @@
+name: Test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  workflow_call:
+    inputs:
+      skip_codecov:
+        description: "Skip Codecov upload"
+        required: false
+        default: true
+        type: boolean
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+          cache: "pip"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Run linter
+        run: ruff check .
+
+      - name: Run formatter check
+        run: ruff format --check .
+
+      - name: Run tests with coverage
+        run: pytest --cov=src --cov-report=xml --cov-report=term
+
+      - name: Upload coverage reports to Codecov
+        if: inputs.skip_codecov != true
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: ./coverage.xml
+          fail_ci_if_error: true

amigo_sdk-0.1.1/.gitignore

@@ -0,0 +1,15 @@
+.venv
+.env
+.pytest_cache
+.ruff_cache
+__pycache__
+
+.vscode
+!.vscode/settings.json
+
+dist/
+
+# Coverage files
+htmlcov/
+coverage.xml
+.coverage

amigo_sdk-0.1.1/CONTRIBUTING.md

@@ -0,0 +1,77 @@
+# Contributing Guide
+
+## Quick Setup
+
+```bash
+# Create and activate virtual environment
+python -m venv .venv
+source .venv/bin/activate
+
+# Install the project in development mode
+pip install -e ".[dev]"
+```
+
+## Development Commands
+
+```bash
+check                     # Run all checks (format, lint, tests)
+check --fix               # Auto-fix issues and run all checks
+check --fast              # Format + lint only (skip tests)
+
+gen-models                # Generate models from API spec
+```
+
+## Workflow
+
+1. **Before committing:** Run `check --fix` to auto-fix issues
+2. **During development:** Use `check --fast` for quick validation
+3. **Update models:** Run `gen-models` when API changes
+
+## Release Process
+
+### GitHub Actions Release
+
+1. Go to the **Actions** tab in GitHub
+2. Select the **Release** workflow
+3. Click **Run workflow** and choose:
+   - **Version type**: `patch` (default), `minor`, or `major`
+   - **Dry run**: Test the release process without publishing
+   - **Production**: Upload to PyPI instead of TestPyPI
+
+The workflow will automatically:
+
+- ✅ Run all tests, linting, and formatting checks (reuses existing test workflow)
+- 🔄 Generate fresh models from the API spec
+- 📈 Increment the version using Hatch
+- 📦 Build the package
+- 🚀 Upload to TestPyPI (or PyPI if production mode)
+- 🏷️ Create a Git tag and GitHub release
+- 📋 Provide detailed summary with links
+
+### Required Repository Secrets
+
+Configure these secrets in your GitHub repository settings:
+
+- `TEST_PYPI_API_TOKEN`: Token for https://test.pypi.org/
+- `PYPI_API_TOKEN`: Token for https://pypi.org/ (production releases)
+
+### Getting API Tokens
+
+1. **TestPyPI**: Go to https://test.pypi.org/manage/account/token/
+2. **PyPI**: Go to https://pypi.org/manage/account/token/
+3. Create a token with upload permissions
+4. Add the token to your repository secrets
+
+## IDE Setup (VS Code)
+
+Install extensions:
+
+- [Ruff](https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff)
+- [Python](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
+
+## Troubleshooting
+
+- **Command not found:** Activate virtual environment with `source .venv/bin/activate`
+- **Linting failures:** Run `check --fix` to auto-fix issues
+- **Model import errors:** Run `gen-models` to regenerate models
+- **Release failures:** Check API tokens are configured in repository secrets and try a dry run first

amigo_sdk-0.1.1/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.

amigo_sdk-0.1.1/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,170 @@
+# 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.