OneWorldSync Python Client

User Guide

  • Installation
    • Requirements
    • Installing from PyPI
    • Installing from Source
    • Development Installation
    • Documentation Installation
    • CLI Configuration
  • Authentication
    • Authentication Credentials
    • Setting Up Authentication
    • Using a .env File
    • Authentication Process
  • Quickstart
    • Command Line Interface
    • Basic Setup
    • Counting Products
    • Fetching Products
    • Advanced Fetching
    • Working with Pagination
    • Fetching Product Hierarchies
    • Error Handling
  • Advanced Usage
    • Using the Criteria Builder
    • Date Range Filtering
    • Working with Product Results
    • Advanced Filtering
    • Sorting Results
    • Field Selection
  • Nutritional Data Integration
    • Overview
    • Nutritional Data Structure
    • Nutrient Code Mapping
    • Known Food Product GTINs
    • Example: Extracting Nutritional Information
    • Limitations
  • Error Handling
    • Exception Hierarchy
    • Basic Error Handling
    • Authentication Errors
    • API Errors
    • Network Errors
    • Best Practices
  • Command Line Interface
    • Installation
    • Configuration
    • Global Options
      • –version
      • –help
    • Commands
      • login
      • fetch
      • count
      • hierarchy
  • OpenAPI Specification
    • Location
    • Usage

API Reference

  • Content1 Client API
    • Content1Client
      • Content1Client
        • Content1Client.__init__()
        • Content1Client.count_products()
        • Content1Client.fetch_products()
        • Content1Client.fetch_hierarchies()
        • Content1Client.fetch_products_by_gtin()
        • Content1Client.fetch_products_by_ip_gln()
        • Content1Client.fetch_products_by_target_market()
        • Content1Client.fetch_next_page()
        • Content1Client.fetch_products_by_date_range()
        • Content1Client.fetch_products_last_30_days()
        • Content1Client.fetch_products_by_brand()
        • Content1Client.fetch_products_by_gpc_code()
        • Content1Client.fetch_products_by_upc()
  • Content1 Authentication API
    • Content1HMACAuth
      • Content1HMACAuth
        • Content1HMACAuth.__init__()
        • Content1HMACAuth.generate_timestamp()
        • Content1HMACAuth.generate_hash()
        • Content1HMACAuth.generate_auth_headers()
  • CLI Module
    • load_credentials()
    • get_client()
  • Models API
    • Content1Product
      • Content1Product
        • Content1Product.__init__()
        • Content1Product.information_provider_gln
        • Content1Product.target_market
        • Content1Product.last_modified_date
        • Content1Product.brand_name
        • Content1Product.gpc_category
        • Content1Product.to_dict()
        • Content1Product.__str__()
    • Content1ProductResults
      • Content1ProductResults
        • Content1ProductResults.__init__()
        • Content1ProductResults.__len__()
        • Content1ProductResults.__iter__()
        • Content1ProductResults.__getitem__()
        • Content1ProductResults.to_dict()
    • Content1Hierarchy
      • Content1Hierarchy
        • Content1Hierarchy.__init__()
        • Content1Hierarchy.to_dict()
        • Content1Hierarchy.__str__()
    • Content1HierarchyResults
      • Content1HierarchyResults
        • Content1HierarchyResults.__init__()
        • Content1HierarchyResults.__len__()
        • Content1HierarchyResults.__iter__()
        • Content1HierarchyResults.__getitem__()
        • Content1HierarchyResults.to_dict()
  • Exceptions API
    • OneWorldSyncError
      • OneWorldSyncError
    • AuthenticationError
      • AuthenticationError
    • APIError
      • APIError
        • APIError.__init__()
  • Utilities API
    • Timestamp Functions
      • format_timestamp()
      • parse_timestamp()
    • Data Extraction Functions
      • extract_nested_value()
      • get_nested_dict_value()
      • extract_product_data()
      • extract_search_results()
      • get_primary_image()
      • format_dimensions()
    • Data Handling Functions
      • pretty_print_json()

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
    • Prerequisites
    • Version Numbering
    • Release Process
      • CLI Method
        • 1. Update Version Numbers
        • 2. Update Changelog
        • 3. Create a Pull Request from Dev to Main
        • 4. Review and Merge the Pull Request
        • 5. Create a GitHub Release
        • 6. Build and Upload to PyPI
      • VS Code Method
        • 1. Prepare for Release
        • 2. Run the Release Tasks
        • 3. Individual Tasks
    • Post-Release
  • VS Code Integration
    • Debug Configurations
    • Tasks
    • Settings
    • Extensions
OneWorldSync Python Client
  • Python Module Index

Python Module Index

o
 
o
- oneworldsync
    oneworldsync.cli
    oneworldsync.content1_auth
    oneworldsync.content1_client
    oneworldsync.criteria
    oneworldsync.exceptions
    oneworldsync.models
    oneworldsync.utils

© Copyright 2025, Michael McGarrah.

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