imerit-ango 1.3.48
Ango-Hub SDK
Keywords: imerit_ango, angohub, Ango, Ango Hub, iMerit

# Ango Hub Python SDK

<img src="https://imerit.net/wp-content/themes/imerit/images/imerit-logo.svg" alt="iMerit" height="60">

A comprehensive Python SDK to interface programmatically with Ango Hub, iMerit's data annotation and AI training platform.

## Overview

The iMerit-Ango SDK provides a powerful Python interface for interacting with Ango Hub, enabling you to:

- **Manage Projects**: Create, configure, and manage annotation projects
- **Upload Data**: Import assets from local storage, cloud storage (AWS S3, GCP, Azure), or URLs
- **Handle Annotations**: Import and export annotations in various formats (COCO, YOLO, KITTI, Ango native format)
- **Workflow Management**: Manage labeling workflows, batches, and task assignments
- **Team Collaboration**: Add team members, manage roles, and track performance
- **Integration**: Connect with your existing ML pipelines and data infrastructure

## Installation

Install the latest version from PyPI:

```bash
pip install imerit-ango
```

To upgrade to the latest version:

```bash
pip install -U imerit-ango
```

## Quick Start

### 1. Get Your API Key

First, obtain your API key from your [Ango Hub account page](https://docs.imerit.net/sdk/sdk-documentation#obtaining-your-api-key):

1. Navigate to your Account page in Ango Hub
2. Go to the API tab
3. Create a new API key or copy your existing key


### 2. Basic Usage

```python
import os
from dotenv import load_dotenv
from imerit_ango.sdk import SDK

# Load environment variables
load_dotenv()

# Initialize SDK
sdk = SDK(api_key=os.getenv('API_KEY'))

# List your projects
projects = sdk.list_projects()
print(f"Found {len(projects)} projects")

# Get project details
project = sdk.get_project(project_id=os.getenv('PROJECT_ID'))
print(f"Project: {project['name']}")
```

## SDK Functions Overview

### Project-Level Functions
- **Project Management**: `create_project()`, `get_project()`, `list_projects()`
- **Data Upload**: `upload_files()`, `upload_files_cloud()`, `upload_chat_assets()`
- **Batch Management**: `create_batch()`, `assign_batches()`, `get_batches()`
- **Task Management**: `get_tasks()`, `assign_task()`, `requeue_tasks()`
- **Annotations**: `import_labels()`, `export()`, `exportV3()`
- **Team**: `add_members_to_project()`
- **Performance**: `get_metrics()`, `get_project_performance()`

### Organization-Level Functions
- **Storage**: `create_storage()`, `get_storages()`, `delete_storage()`
- **Members**: `invite_members_to_org()`, `get_organization_members()`
- **Permissions**: `update_organization_members_role()`

## Supported Asset Types

The SDK supports a wide variety of data types:

- **Images**: PNG, JPEG, TIFF, BMP, WebP
- **Videos**: MP4, AVI, MOV, WebM
- **Medical**: DICOM, NRRD files
- **Documents**: PDF, Markdown, HTML
- **Text**: Plain text, NER datasets
- **3D Data**: Point clouds, multi-sensor fusion
- **Audio**: WAV, MP3, FLAC
- **LLM**: Chat conversations and responses

## Documentation

### Comprehensive Documentation
Full SDK documentation is available at: https://docs.imerit.net/sdk/sdk-documentation

### Key Resources
- [Installation Guide](https://docs.imerit.net/sdk/sdk-documentation#sdk-installation)
- [API Reference](https://docs.imerit.net/sdk/sdk-documentation#project-level-sdk-functions)
- [Usage Examples](https://docs.imerit.net/sdk/sdk-useful-snippets)
- [Troubleshooting](https://docs.imerit.net/troubleshooting)

## Examples

### Upload and Create a Labeling Project

```python
# Create a new project
project = sdk.create_project(
    organization_id=org_id,
    name="My Annotation Project",
    description="Object detection for autonomous vehicles"
)

# Upload images from local directory
sdk.upload_files(
    project_id=project['_id'],
    file_paths=['/path/to/images/*.jpg']
)

# Create batches for organized labeling
batch = sdk.create_batch(
    project_id=project['_id'],
    batch_name="Training Set Batch 1"
)
```

### Export Annotations

```python
# Export annotations in COCO format
export_result = sdk.export(
    project_id=project_id,
    export_format='COCO'
)

# Download the export
import requests
response = requests.get(export_result['downloadUrl'])
with open('annotations.json', 'wb') as f:
    f.write(response.content)
```

## Support

- **Documentation**: [https://docs.imerit.net](https://docs.imerit.net)
- **Status Page**: [Ango Hub Status](https://docs.imerit.net/other/ango-hub-status-page)
- **Customer Support**: Available through your Ango Hub account

## License

This SDK is provided by iMerit Technology Services for use with Ango Hub platform.

---

For the latest updates and detailed API reference, visit our [complete documentation](https://docs.imerit.net/sdk/sdk-documentation).