oneworldsync 0.1.5

A Python client for the 1WorldSync Content1 Search and Fetch REST API

1WorldSync Python Client

A Python Client library module for accessing the 1WorldSync Content1 Search and Fetch REST API.

Package Structure

oneworldsync_python/
├── oneworldsync/
│   ├── __init__.py      # Package exports
│   ├── auth.py          # HMAC authentication
│   ├── client.py        # Main API client
│   ├── exceptions.py    # Custom exceptions
│   ├── models.py        # Data models for API responses
│   └── utils.py         # Utility functions
├── examples/
│   ├── search_example.py           # Example for product search
│   ├── advanced_search_example.py  # Example for advanced product search
│   └── product_fetch_example.py    # Example for fetching product details
├── tests/               # Test suite
│   ├── conftest.py      # Test configuration and fixtures
│   ├── test_auth.py     # Tests for authentication
│   ├── test_client.py   # Tests for API client
│   └── ...              # Other test files
├── README.md            # Documentation
├── .env.example         # Example environment variables file
└── setup.py             # Package installation

Key Features

• HMAC Authentication: Handles the complex HMAC authentication required by the 1WorldSync API.
• Easy-to-use Client: Provides a simple interface for interacting with the API.
• Data Models: Structured models for API responses, making it easier to work with the data.
• Error Handling: Custom exceptions for different types of errors.
• Examples: Ready-to-use example scripts demonstrating common use cases.

Installation

pip install oneworldsync

Or install from source:

git clone https://github.com/mcgarrah/oneworldsync_client.git
cd oneworldsync_python
pip install -e .

Development Installation

To install with development dependencies:

pip install -e ".[dev]"

Or using the requirements files:

pip install -r requirements-dev.txt

Authentication

The 1WorldSync API uses HMAC authentication. You'll need an App ID and Secret Key from 1WorldSync.

You can store these credentials in a .env file:

ONEWORLDSYNC_APP_ID=your_app_id
ONEWORLDSYNC_SECRET_KEY=your_secret_key
ONEWORLDSYNC_API_URL=1ws_api_endpoint

Important Note: The 1WorldSync API is very particular about the order of parameters in the authentication process. The parameters must be in a specific order when constructing the string to hash. This library handles this complexity for you, ensuring that parameters are ordered correctly for authentication.

Usage

Basic Usage

from oneworldsync import OneWorldSyncClient
import os
from dotenv import load_dotenv

# Load credentials from .env file
load_dotenv()
app_id = os.getenv("ONEWORLDSYNC_APP_ID")
secret_key = os.getenv("ONEWORLDSYNC_SECRET_KEY")

# Initialize client
client = OneWorldSyncClient(app_id, secret_key)

# Perform a free text search
results = client.free_text_search("milk")

# Print number of results
print(f"Found {len(results.products)} products")

# Print details of the first product
if results.products:
    product = results.products[0]
    print(f"Product: {product.brand_name} - {product.product_name}")
    print(f"Description: {product.description}")

Advanced Search

# Search for a product by UPC
results = client.advanced_search("itemIdentifier", "16241419122223")

# Search with geo location
results = client.free_text_search(
    "coffee",
    geo_location=(37.7749, -122.4194)  # San Francisco coordinates
)

Working with Products

# Get a specific product by ID
product_data = client.get_product("some_product_id")

# Access product attributes
for product in results.products:
    print(f"ID: {product.item_id}")
    print(f"Brand: {product.brand_name}")
    print(f"Name: {product.product_name}")
    print(f"Description: {product.description}")
    
    # Get product dimensions
    dimensions = product.dimensions
    if dimensions:
        print(f"Dimensions: {dimensions['height']['value']} {dimensions['height']['unit']} x "
              f"{dimensions['width']['value']} {dimensions['width']['unit']} x "
              f"{dimensions['depth']['value']} {dimensions['depth']['unit']}")
    
    # Get product images
    for image in product.images:
        print(f"Image URL: {image['url']} (Primary: {image['is_primary']})")

Error Handling

from oneworldsync import OneWorldSyncClient, AuthenticationError, APIError

try:
    client = OneWorldSyncClient(app_id, secret_key)
    results = client.free_text_search("apple")
except AuthenticationError as e:
    print(f"Authentication failed: {e}")
except APIError as e:
    print(f"API error: {e}")
    print(f"Status code: {e.status_code}")

Development

VS Code Integration

This project includes VS Code configuration files to streamline development:

Debug Configurations (launch.json)

• Python: Current File - Run and debug the currently open file
• Python: Search Example - Run the basic search example
• Python: Advanced Search Example - Run the advanced search example
• Python: Product Fetch Example - Run the product fetch example
• Python: Debug Tests - Debug the current test file
• Python: All Tests - Run all tests with verbose output
• Python: Tests with Coverage - Run tests with coverage reporting

To use these configurations, press F5 or select from the debug dropdown in VS Code.

Tasks (tasks.json)

Run common development tasks with Ctrl+Shift+P → "Tasks: Run Task":

• Run Tests - Run pytest on the project
• Run Tests with Coverage - Run tests with coverage reporting
• Lint with Flake8 - Check code style with Flake8
• Format with Black - Format code with Black
• Sort imports with isort - Sort imports with isort
• Type check with mypy - Run static type checking
• Build Documentation - Build Sphinx documentation
• Update Version - Run the version update script with a prompt for the new version
• Install Development Dependencies - Install dev dependencies
• Install Documentation Dependencies - Install docs dependencies

Running Tests

# Install test dependencies
pip install -e ".[dev]"
# or
pip install -r requirements-dev.txt

# Run tests
pytest

# Run tests with coverage
pytest --cov=oneworldsync

Version Management

To update the version number across all files (oneworldsync/__init__.py, pyproject.toml, and setup.py), use the provided script:

# Update to version 0.1.4
python version_update.py 0.1.4

Troubleshooting

If you encounter authentication issues, check that:

1. Your ONEWORLDSYNC_APP_ID and ONEWORLDSYNC_SECRET_KEY are correct
2. You're using the correct environment (production vs. preprod) for your credentials
3. Your system clock is synchronized (timestamp accuracy is important for authentication)

For API errors with status code 400, check the response message for details about which parameters might be invalid.