WooCommerce Product Manager

This project contains scripts to manage products, categories, and tags in a WooCommerce store. It allows you to extract data, upload it back to the store, and create backups of the data.

Features

• Extract all product data from a WooCommerce store and save it to a CSV file.
• Extract product categories and tags and save them to CSV files.
• Automatically create timestamped backups of the CSV files for added security.
• Set backup files to read-only to prevent accidental deletion or modification.
• Upload product data, categories, and tags to the WooCommerce store.
• Restore data from specific backup files.
• Interactive menu to manage data extraction, upload, and restore backups.

Setup

Prerequisites

• Python 3.x
• Virtual environment (recommended)

Installation

1. Clone the repository:

   git clone https://github.com/JMViJi/woocommerce-product-manager.git
   cd woocommerce-product-manager

2. Create and activate a virtual environment:

   python -m venv venv
   source venv/bin/activate  

3. Install the required dependencies:

   pip install -r requirements.txt

4. Create a .env file with your WooCommerce credentials:

   WOO_URL=https://yourstore.com/wp-json/
   CONSUMER_KEY=your_consumer_key
   CONSUMER_SECRET=your_consumer_secret

Obtaining WooCommerce API Keys

To obtain the API keys for your WooCommerce store, follow these steps:

1. Log in to your WooCommerce store's WordPress admin dashboard.
2. Go to WooCommerce > Settings.
3. Click on the Advanced tab, then select REST API.
4. Click the Add Key button.
5. Fill in the Description (e.g., "Product Manager Script").
6. Select the User you want to generate the key for in the User field.
7. Set Permissions to Read/Write.
8. Click the Generate API Key button.
9. You will be shown a Consumer Key and a Consumer Secret. Copy these keys and paste them into your .env file as CONSUMER_KEY and CONSUMER_SECRET, respectively.

Usage

Extract Products

This script fetches all product data from the WooCommerce store, saves it to a CSV file, and creates a timestamped backup of the CSV file.

python src/extract.py

Upload Data

This script uploads product data, categories, or tags to the WooCommerce store.

python src/upload.py [products|categories|tags]

Restore Backup

Restore a backup of the product data, categories, or tags.

python src/restore.py

Detailed Script Descriptions

extract.py

• Fetch Product Data: The script connects to the WooCommerce API and retrieves all product data.
• Save to CSV: The fetched product data is saved to data/products.csv.
• Create Backup: A timestamped backup of the CSV file is created in the data/backups/products/ directory. The backup file is named products_backup_YYYYMMDD_HHMMSS.csv and is set to read-only to prevent accidental deletion or modification.

upload.py

• Upload Products: This script uploads product data to the WooCommerce store. It reads product data from data/products.csv and uses the WooCommerce API to update the store.
• Upload Categories: This script uploads category data to the WooCommerce store. It reads category data from data/categories.csv and uses the WooCommerce API to update the store.
• Upload Tags: This script uploads tag data to the WooCommerce store. It reads tag data from data/tags.csv and uses the WooCommerce API to update the store.

restore.py

• Restore Backup: This script allows you to restore data from specific backup files. You can choose to restore products, categories, or tags from their respective backups.

Project Structure

woocommerce-product-manager/
│
├───src/
│   ├───backup.py
│   ├───config.py
│   ├───extract.py
│   ├───upload.py
│   ├───restore.py
│   ├───utils.py
│   └───__pycache__/
│
├───data/
│   ├───backups/
│   │   ├───categories/
│   │   ├───products/
│   │   └───tags/
│   ├───categories.csv
│   ├───products.csv
│   └───tags.csv
│
├───.gitignore
├───main.py
├───README.md
├───requirements.txt
└───.env