ddex-workbench 1.0.2

Official Python SDK for DDEX Workbench - Open-source DDEX validation tools

DDEX Workbench Python SDK

Official Python SDK for DDEX Workbench - Open-source DDEX validation and processing tools for the music industry.

🎉 New in Version 1.0.2

• Enhanced Schematron Rules: Comprehensive business rule validation with meaningful, actionable SVRL reports
• SVRL Report Generation: Generate detailed validation reports in Schematron Validation Report Language format
• Auto-Detection: Automatically detect ERN version and profile from XML content
• Concurrent Batch Processing: Validate multiple files in parallel with configurable worker pools
• URL and File Validation: Validate XML directly from URLs or files with optional hash generation
• Advanced Error Filtering: Separate and analyze errors by type (Schematron, XSD, Business Rules)
• Profile Compliance Reports: Get detailed compliance statistics with pass/fail rates
• Metadata Extraction: Extract message IDs, creation dates, and release counts from XML
• Enhanced Error Classes: Specialized error handling for parsing, files, configuration, and API errors
• Dynamic API Key Management: Update or clear API keys without recreating client

See CHANGELOG.md for full details.

Features

• 🚀 Simple API - Intuitive methods for all DDEX validation operations
• 🔧 Full Type Safety - Type hints, dataclasses, and IDE autocomplete support
• 🌐 Smart Networking - Connection pooling, retry logic, and timeout handling
• 📊 Flexible Validation - Support for ERN 3.8.2, 4.2, and 4.3 with all profiles
• 🎯 Comprehensive Error Reporting - Detailed errors with line numbers, context, and suggestions
• 📈 Multiple Report Formats - JSON, CSV, text, and SVRL output formats
• 🔑 Authentication Support - API key management for higher rate limits
• ⚡ High Performance - Efficient XML processing and parallel batch operations
• 🛡️ Robust Error Handling - Specialized exception classes for different error scenarios
• 📦 Zero Configuration - Works out of the box with sensible defaults

Installation

pip install ddex-workbench

For development:

pip install ddex-workbench[dev]

Quick Start

from ddex_workbench import DDEXClient

# Initialize client (API key optional for higher rate limits)
client = DDEXClient(api_key="ddex_your-api-key")

# Validate ERN XML
with open("release.xml", "r") as f:
    xml_content = f.read()

result = client.validate(xml_content, version="4.3", profile="AudioAlbum")

if result.valid:
    print("✅ Validation passed!")
else:
    print(f"❌ Found {len(result.errors)} errors:")
    for error in result.errors[:5]:
        print(f"  Line {error.line}: {error.message}")

New v1.0.2 Features

Auto-Detection and Validation

# Automatically detect version and profile
result = client.validator.validate_auto(xml_content)

# Just detect without validating
version = client.validator.detect_version(xml_content)
profile = client.validator.detect_profile(xml_content)

# Extract metadata
metadata = client.validator.extract_metadata(xml_content)
print(f"Message ID: {metadata['message_id']}")
print(f"Release Count: {metadata['release_count']}")

Batch Processing with Concurrency

from pathlib import Path

# Validate multiple files concurrently
xml_files = list(Path("releases").glob("*.xml"))

batch_result = client.validator.validate_batch(
    files=xml_files,
    version="4.3",
    profile="AudioAlbum",
    max_workers=8  # Process 8 files concurrently
)

print(f"Validated {batch_result.total_files} files in {batch_result.processing_time:.2f}s")
print(f"Valid: {batch_result.valid_files}, Invalid: {batch_result.invalid_files}")

SVRL Report Generation

# Generate SVRL (Schematron Validation Report Language) report
result, svrl = client.validate_with_svrl(
    content=xml_content,
    version="4.3",
    profile="AudioAlbum"
)

if svrl:
    with open("validation-report.svrl", "w") as f:
        f.write(svrl)
    print("SVRL report saved")

# Or use validation options
from ddex_workbench import ValidationOptions

options = ValidationOptions(
    generate_svrl=True,
    verbose=True,
    include_passed_rules=True
)

result = client.validate(xml_content, version="4.3", options=options)

Profile Compliance Reporting

# Get detailed compliance report
summary = client.validator.get_profile_compliance(
    content=xml_content,
    version="4.3",
    profile="AudioAlbum"
)

print(f"Compliance Rate: {summary.pass_rate:.1%}")
print(f"Passed Rules: {summary.passed_rules}/{summary.total_rules}")
print(f"Schematron Errors: {summary.schematron_errors}")
print(f"XSD Errors: {summary.xsd_errors}")
print(f"Business Rule Errors: {summary.business_rule_errors}")

Enhanced Error Filtering and Analysis

# Filter errors by type
schematron_errors = client.validator.get_schematron_errors(result)
xsd_errors = client.validator.get_xsd_errors(result)
business_errors = client.validator.get_business_rule_errors(result)
critical_errors = client.validator.get_critical_errors(xml_content, "4.3")

# Format errors with grouping
formatted = client.validator.format_errors(
    result,
    group_by_rule=True,
    include_context=True,
    max_per_group=5
)
print(formatted)

# Generate comprehensive summary
summary_text = client.validator.generate_summary(result)
print(summary_text)

URL and File Validation

# Validate from URL
result = client.validator.validate_url(
    url="https://example.com/release.xml",
    version="4.3",
    profile="AudioAlbum"
)

# Validate file with hash generation
result = client.validator.validate_file(
    filepath=Path("release.xml"),
    version="4.3",
    generate_hash=True  # Adds MD5 and SHA256 to metadata
)

print(f"File hash: {result.metadata['file_hash_sha256']}")

Usage Examples

Basic Validation

from ddex_workbench import DDEXClient

client = DDEXClient()

# Validate with specific version
result = client.validate(xml_content, version="4.3")

# Validate with profile
result = client.validate(xml_content, version="4.3", profile="AudioAlbum")

# Check validation status
if result.valid:
    print("Validation passed!")
else:
    print(f"Errors: {len(result.errors)}")
    print(f"Warnings: {len(result.warnings)}")

Advanced Validation Options

from ddex_workbench import DDEXClient, ValidationOptions

client = DDEXClient()

# Configure validation options
options = ValidationOptions(
    generate_svrl=True,           # Generate SVRL report
    verbose=True,                  # Include detailed information
    include_passed_rules=True,     # Show which rules passed
    max_errors=100                 # Limit number of errors
)

result = client.validate(
    content=xml_content,
    version="4.3",
    profile="AudioAlbum",
    options=options
)

# Access additional information
if result.passed_rules:
    print(f"Passed {len(result.passed_rules)} rules")

if result.svrl:
    print("SVRL report generated")

Dynamic API Key Management

client = DDEXClient()

# Set API key dynamically
client.set_api_key("ddex_your-api-key")

# Update API key
client.set_api_key("ddex_new-api-key")

# Clear API key (use anonymous mode)
client.clear_api_key()

# Get current configuration
config = client.get_config()
print(f"Base URL: {config['base_url']}")
print(f"Timeout: {config['timeout']}s")

Error Handling

from ddex_workbench import (
    DDEXClient,
    RateLimitError,
    ValidationError,
    AuthenticationError,
    ParseError,
    FileError,
    NetworkError
)

client = DDEXClient()

try:
    result = client.validate(xml_content, version="4.3")
except RateLimitError as e:
    print(f"Rate limited. Retry after {e.retry_after} seconds")
    print(e.get_retry_message())
except AuthenticationError:
    print("Invalid API key")
except ParseError as e:
    print(f"XML parsing error at {e.get_location()}: {e.message}")
except FileError as e:
    print(f"File error: {e.message}")
    if e.filepath:
        print(f"File: {e.filepath}")
except NetworkError as e:
    print(f"Network error: {e.message}")
    if e.can_retry:
        print(e.get_retry_message())
except ValidationError as e:
    print(f"Validation failed: {e.get_summary()}")
except DDEXError as e:
    print(f"DDEX error: {e}")

Health Check and Status

# Check API health
health = client.health()
print(f"API Status: {health.status}")
print(f"Version: {health.version}")
print(f"Timestamp: {health.timestamp}")

# Get supported formats
formats = client.formats()
print(f"Supported formats: {formats.formats}")
print(f"ERN versions: {formats.versions}")
print(f"Profiles: {formats.profiles}")

Context Manager

# Automatic session cleanup
with DDEXClient(api_key="ddex_key") as client:
    result = client.validate(xml_content, version="4.3")
    # Session automatically closed after block

Command Line Interface

# Validate a file
ddex-validate release.xml --version 4.3 --profile AudioAlbum

# Auto-detect version
ddex-validate release.xml --auto

# Validate with SVRL generation
ddex-validate release.xml --version 4.3 --svrl report.svrl

# Batch validate directory
ddex-validate releases/ --version 4.3 --recursive --workers 8

# Generate compliance report
ddex-validate release.xml --version 4.3 --profile AudioAlbum --compliance

Configuration

from ddex_workbench import DDEXClient

# Full configuration
client = DDEXClient(
    api_key="ddex_your-api-key",           # Optional API key
    base_url="https://api.ddex-workbench.org/v1",  # API endpoint
    timeout=30,                             # Request timeout in seconds
    max_retries=3,                          # Max retry attempts
    retry_delay=1.0,                        # Initial retry delay
    verify_ssl=True                         # SSL verification
)

Supported Versions and Profiles

ERN Versions

• ERN 4.3 (Recommended)
• ERN 4.2
• ERN 3.8.2

Profiles by Version

ERN 4.3 & 4.2:

• AudioAlbum
• AudioSingle
• Video
• Mixed
• Classical
• Ringtone
• DJ

ERN 3.8.2:

• All above profiles plus:
• ReleaseByRelease

Requirements

• Python 3.7+
• requests 2.28+
• urllib3 1.26+

Development

# Clone repository
git clone https://github.com/daddykev/ddex-workbench.git
cd ddex-workbench/packages/python-sdk

# Install development dependencies
pip install -e ".[dev]"

# Run tests
pytest

# Run tests with coverage
pytest --cov=ddex_workbench --cov-report=html

# Run linting
flake8 ddex_workbench
black --check ddex_workbench
mypy ddex_workbench

# Format code
black ddex_workbench
isort ddex_workbench

CI/CD Integration

# example_ci.py
from ddex_workbench import DDEXClient
from pathlib import Path
import sys

client = DDEXClient()

# Validate all releases
releases = Path("releases").glob("*.xml")
all_valid = True

for release_file in releases:
    result = client.validator.validate_file(release_file, version="4.3")
    
    if not result.valid:
        all_valid = False
        print(f"❌ {release_file.name}: {len(result.errors)} errors")
        
        # Show first 3 errors
        for error in result.errors[:3]:
            print(f"  Line {error.line}: {error.message}")
    else:
        print(f"✅ {release_file.name}: Valid")

# Exit with appropriate code
sys.exit(0 if all_valid else 1)

Testing

# Run all tests
pytest

# Run specific test file
pytest tests/test_client.py

# Run integration tests
pytest tests/integration/

# Run with coverage
pytest --cov=ddex_workbench --cov-report=html

# Run tests in parallel
pytest -n auto

Documentation

• 📚 Full Documentation
• 🌐 API Reference
• 📖 DDEX Standards

Contributing

We welcome contributions! Please see our Contributing Guide for details.

Quick Start for Contributors

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Make your changes with tests
4. Run the test suite (pytest)
5. Commit your changes (git commit -m 'Add amazing feature')
6. Push to the branch (git push origin feature/amazing-feature)
7. Open a Pull Request

Support

• 💬 GitHub Issues - Bug reports and feature requests
• 📧 Email Support - Direct support
• 🌐 Website - Web application
• 📚 Documentation - Full documentation

License

MIT License - see LICENSE for details.

Related Projects

• DDEX Workbench Web App - Web-based validation interface
• @ddex-workbench/sdk - JavaScript/TypeScript SDK
• DDEX Knowledge Base - Official DDEX documentation

Changelog

See CHANGELOG.md for a detailed version history.

Recent Updates (v1.0.2)

• ✅ Schematron validation support
• ✅ SVRL report generation
• ✅ Auto-detection of version and profile
• ✅ Batch processing with concurrency
• ✅ URL and file validation methods
• ✅ Profile compliance reporting
• ✅ Enhanced error filtering
• ✅ Dynamic API key management

Acknowledgments

Built with ❤️ for the music industry by the DDEX Workbench team.

Special thanks to:

• The DDEX organization for maintaining industry standards
• The music technology community for feedback and support
• All contributors who help make DDEX more accessible

---

DDEX Workbench - Making DDEX validation simple, fast, and reliable.