MT Providers

Table of Contents

Overview

Key Features

Quick Start

Installation

# Install the framework
pip install mt-providers
# Install providers (example with Microsoft Translator)
pip install mt_provider_microsoft

Basic Usage

from mt_providers import get_provider
from mt_providers.types import TranslationConfig
# Configure your provider
config = TranslationConfig(
 api_key="your-api-key",
 region="westus2" # Required for some providers like Microsoft
)
# Get a provider instance
translator = get_provider("microsoft")(config)
# Translate text
result = translator.translate("Hello world", "en", "es")
print(result["translated_text"]) # Output: ¡Hola mundo!
# Batch translation
texts = ["Hello", "World", "How are you?"]
results = translator.bulk_translate(texts, "en", "es")
for result in results:
 print(result["translated_text"])

Async Usage

import asyncio
async def async_translation():
 result = await translator.translate_async("Hello world", "en", "es")
 print(result["translated_text"])
asyncio.run(async_translation())

Available Providers

Provider Management

from mt_providers import list_providers, discover_providers
# List all available providers 
providers = list_providers()
print(f"Available providers: {providers}") # ['microsoft']
# Discover providers from entry points
discovered = discover_providers()
print(f"Discovered providers: {discovered}")
# Check provider health
from mt_providers.registry import check_provider_health
is_healthy = await check_provider_health("microsoft", config)
print(f"Provider healthy: {is_healthy}")

Configuration

Basic Configuration

from mt_providers.types import TranslationConfig
config = TranslationConfig(
 api_key="your-api-key",
 region="your-region", # Provider-specific
 timeout=30, # Request timeout in seconds
 rate_limit=10, # Requests per second
 retry_attempts=3, # Number of retries
 retry_backoff=1.0, # Backoff multiplier
 user_agent_name="MyApp", # Optional: Custom UA name
 user_agent_version="1.0" # Optional: Custom UA version (required if name is set)
)

Environment-Based Configuration

import os
config = TranslationConfig(
 api_key=os.getenv("TRANSLATION_API_KEY"),
 region=os.getenv("TRANSLATION_REGION", "westus2"),
 rate_limit=int(os.getenv("TRANSLATION_RATE_LIMIT", "10")),
 user_agent_name=os.getenv("APP_NAME"), # Optional: For application identification
 user_agent_version=os.getenv("APP_VERSION") # Optional: Application version
)

Error Handling

from mt_providers.exceptions import ProviderNotFoundError, ConfigurationError
from mt_providers.types import TranslationStatus
try:
 translator = get_provider("microsoft")(config)
 result = translator.translate("Hello", "en", "es")
 
 # Check result status - all errors are returned in the response
 if result["status"] == TranslationStatus.SUCCESS:
 print(f"Translation: {result['translated_text']}")
 else:
 print(f"Translation failed: {result['error']}")
 
except ProviderNotFoundError:
 print("Provider not found in registry")
except ConfigurationError:
 print("Provider configuration error")

Advanced Features

Rate Limiting

# Configure rate limiting
config = TranslationConfig(
 api_key="your-key",
 region="westus2",
 rate_limit=100 # 100 requests per second
)
# Rate limiting is automatically applied
results = translator.bulk_translate(large_text_list, "en", "es")

Custom Provider Development

from mt_providers import BaseTranslationProvider
from mt_providers.types import TranslationResponse
class MyProvider(BaseTranslationProvider):
 name = "my_provider"
 
 def translate(self, text: str, source_lang: str, target_lang: str) -> TranslationResponse:
 # Your implementation here
 return self._create_response(
 translated_text="translated text",
 source_lang=source_lang,
 target_lang=target_lang,
 char_count=len(text)
 )

[project.entry-points."mt_providers"]
my_provider = "my_package.module:MyProvider"

Documentation

Quick Links

Testing

# Run all tests
pytest
# Run with coverage report 
pytest --cov=mt_providers --cov-report=html
# Run specific test categories
pytest tests/test_integration.py # Integration tests
pytest tests/test_provider.py # Provider tests 
pytest tests/test_registry.py # Registry tests
# Type checking
mypy mt_providers
# Code formatting and linting
black mt_providers
isort mt_providers

Test Coverage

Performance

Benchmarks

Compatibility

Contributing

How to Contribute

Areas for Contribution

Development Setup

# Clone the repository
git clone https://github.com/assystant/mt-providers.git
cd mt-providers
# Create virtual environment
python -m venv .venv
source .venv/bin/activate # or `.venv\Scripts\activate` on Windows
# Install development dependencies
pip install -e .[test,dev]
# Run tests
pytest
# Run type checking
mypy mt_providers
# Format code
black mt_providers
isort mt_providers

Project Structure

mt_providers/
├── mt_providers/ # Core framework code
│ ├── base.py # Base provider class
│ ├── registry.py # Provider discovery and registration
│ ├── types.py # Type definitions
│ ├── exceptions.py # Custom exceptions
│ └── utils.py # Utility functions
├── tests/ # Comprehensive test suite
├── docs/ # Documentation
└── examples/ # Usage examples

License

Support & Community

Changelog

Roadmap

Current Status

Upcoming Features