Catsy Python SDK

The Catsy Python SDK is a developer toolkit for integrating Catsy PIM Software with modern applications. It provides a simple interface to the Catsy v4 API, making it easy to manage products, attributes, categories, assets, and collections directly from Python. This SDK enables seamless data synchronization between Catsy PIM and leading platforms such as WordPress, WooCommerce, BigCommerce, and other eCommerce or content management systems. With these integration samples, developers can automate product updates, upload digital assets, and generate SEO-optimized content powered by Catsy’s centralized product information management system.

Requirements

• Python 3.10 or higher
• Git
• pip (Python package installer)

Installation

1. Install Python and pip

   • Windows:

     1. Download Python installer from python.org
     2. Run the installer
     3. IMPORTANT: Check "Add Python to PATH" during installation
     4. pip comes included with Python 3.4+
     5. Verify installation:

        python --version
        pip --version

   • macOS:

     1. Using Homebrew (recommended):

        brew install python

        This installs both Python and pip
     2. Or download from python.org
     3. Verify installation:

        python3 --version
        pip3 --version

   • Linux:

     1. Using package manager:

        # Ubuntu/Debian
        sudo apt update
        sudo apt install python3 python3-pip
        
        # Fedora
        sudo dnf install python3 python3-pip
        
        # Arch Linux
        sudo pacman -S python python-pip

     2. Verify installation:

        python3 --version
        pip3 --version

2. Install Git

   • Download from git-scm.com

3. Clone and Setup

   git clone https://github.com/CatsyAI/Catsy-Python-SDK.git
   cd catsy-python
   
   # Create virtual environment
   python -m venv venv
   
   # Activate virtual environment
   # Windows:
   .\venv\Scripts\activate
   # Unix/macOS:
   source venv/bin/activate
   
   # Install dependencies
   pip install -e .

4. Configure API Key

   • Open examples/config.py
   • Replace TOKEN with your Catsy API key
   • Replace OPENAI_API_KEY with your OpenAI API key (if using AI features)
   • Set other configuration values as needed

Working Examples

These examples have been tested and confirmed working with the Catsy v4 API:

Basic Operations

1. View Single Item

   # Set ITEMID_GET in config.py
   python examples/item_get.py

2. View Multiple Items

   python examples/items_get.py

3. Update Item

   python examples/item_update.py

4. Delete Item

   # Set ITEMID_DELETE in config.py
   python examples/item_delete.py

Asset Management

1. List Assets

   python examples/assets_get.py

2. Upload Asset

   # Set ASSET_PATH in config.py
   python examples/asset_upload.py

Metadata Management

1. List Categories

   python examples/categories_get.py

2. List Attributes

   python examples/attributes_get.py

Collection Operations

1. Get Items in Collection

   # Set COLLECTION_ID in config.py
   python examples/items_in_collection_get.py

Channel Operations

1. Get Items in Channel

   # Set CHANNEL_ID in config.py
   python examples/items_in_channel_get.py

Advanced Features

1. Interactive Item Update

   python examples/item_update_interactive.py

   • Lists all available items with SKUs and names
   • Choose item by index or SKU
   • View and select attributes
   • Enter new values
   • Logs saved to catsy_update.log

2. AI-Enhanced Item Update

   # Set OPENAI_API_KEY in config.py
   python examples/item_update_ai.py

   • Generates SEO-optimized content
   • Supports multiple attribute types
   • Interactive item selection
   • Preview before updating

E-commerce Integration (In Development)

1. WooCommerce Integration

   # Set WOOCOMMERCE config in config.py
   python examples/catsy-to-woocommerce.py

2. BigCommerce Integration

   # Set BIGCOMMERCE config in config.py
   python examples/catsy-to-bigcommerce.py

3. Add Items to Channel

   # Set CHANNEL_ID and ITEM_SKUS in config.py
   python examples/channel_item_add.py

4. Remove Items from Channel

   # Set CHANNEL_ID and ITEM_SKUS in config.py
   python examples/channel_item_remove.py

Support

For any questions or issues:

• Email: support@catsy.com
• Documentation: Catsy API v4 Documentation