OneWorldSync Python Client

User Guide

  • Installation
    • Requirements
    • Installing from PyPI
    • Installing from Source
    • Development Installation
    • Documentation Installation
  • Authentication
    • Obtaining Credentials
    • Storing Credentials
    • Authentication Process
    • Using the Client
    • Authentication Errors
  • Quickstart
    • Basic Setup
    • Free Text Search
    • Advanced Search
    • Geo-Location Search
    • Working with Search Results
    • Fetching a Specific Product
  • Advanced Usage
    • Advanced Search Options
    • Pagination
    • Geo-Location Search
    • Custom API URL
    • Request Timeout
    • Working with Product Data
  • Error Handling
    • Exception Hierarchy
    • Basic Error Handling
    • Authentication Errors
    • API Errors
    • Network Errors
    • Best Practices

API Reference

  • Client API
    • OneWorldSyncClient
      • OneWorldSyncClient
        • OneWorldSyncClient.__init__()
        • OneWorldSyncClient.search_products()
        • OneWorldSyncClient.get_product()
        • OneWorldSyncClient.advanced_search()
        • OneWorldSyncClient.free_text_search()
  • Authentication API
    • HMACAuth
      • HMACAuth
        • HMACAuth.__init__()
        • HMACAuth.generate_timestamp()
        • HMACAuth.generate_hash()
        • HMACAuth.prepare_auth_params()
        • HMACAuth.get_auth_url()
  • Models API
    • Product
      • Product
        • Product.__init__()
        • Product.item_id
        • Product.brand_name
        • Product.product_name
        • Product.description
        • Product.images
        • Product.dimensions
        • Product.__str__()
    • SearchResults
      • SearchResults
        • SearchResults.__init__()
        • SearchResults.__len__()
        • SearchResults.__iter__()
        • SearchResults.__getitem__()
  • Exceptions API
    • OneWorldSyncError
      • OneWorldSyncError
    • AuthenticationError
      • AuthenticationError
    • APIError
      • APIError
        • APIError.__init__()
  • Utilities API
    • Timestamp Functions
      • format_timestamp()
      • parse_timestamp()
    • Data Handling Functions
      • pretty_print_json()
      • extract_nested_value()

Development

  • Contributing
    • Setting Up Development Environment
    • Code Style
    • Pull Request Process
    • Commit Message Guidelines
    • Testing
    • Documentation
  • Testing
    • Test Structure
    • Running Tests
    • Integration Tests
    • Test Coverage
    • Mocking
    • Adding New Tests
  • Releasing
    • Version Numbering
    • Release Process
      • 1. Update Version Numbers
      • 2. Update Changelog
      • 3. Create a Release Commit
      • 4. Build and Upload to PyPI
      • 5. Create GitHub Release
      • 6. Update Documentation
    • Post-Release
  • VS Code Integration
    • Debug Configurations
    • Tasks
    • Settings
    • Extensions
OneWorldSync Python Client
  • Search

© Copyright 2025, Michael McGarrah.

Built with Sphinx using a theme provided by Read the Docs.