ecommerce-toolkit 0.1.1

A unified interface for e-commerce platform APIs

E-commerce Toolkit

A unified interface for interacting with various e-commerce platform APIs. Currently supports Shopify and WooCommerce.

Features

• Automatic platform detection
• Simple, unified interface for all supported platforms
• Environment-based configuration
• Product listing, search, and detailed view capabilities

Installation

pip install ecommerce-toolkit

Quick Start

1. Set up your environment variables in a .env file:

STORE_URL=your-store.com
STORE_TYPE=shopify  # or woocommerce

# For Shopify
SHOPIFY_ACCESS_TOKEN=your_access_token

# For WooCommerce
WOO_CONSUMER_KEY=your_consumer_key
WOO_CONSUMER_SECRET=your_consumer_secret

2. Use the toolkit:

from ecommerce_toolkit import toolkit

# List all products
products = toolkit.list_all_products()

# Search for products
results = toolkit.search_store("t-shirt")

# Get specific product
product = toolkit.get_product_details("123")

Development

1. Clone the repository
2. Create a virtual environment:

python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

3. Install development dependencies:

pip install -e ".[dev]"

4. Run tests:

pytest tests/

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Structure

ecommerce_toolkit/ │ ├── src/ │ └── ecommerce_toolkit/ │ ├── init.py │ ├── providers/ │ │ ├── init.py │ │ ├── base.py # Contains EcommerceProvider ABC │ │ ├── shopify.py # ShopifyProvider implementation │ │ └── woocommerce.py # WooCommerceProvider implementation │ ├── models/ │ │ ├── init.py │ │ └── product.py # Product dataclass │ ├── config.py # StoreConfig class │ └── toolkit.py # Main EcommerceToolkit class │ ├── tests/ │ ├── init.py │ ├── test_shopify.py │ ├── test_woocommerce.py │ └── test_toolkit.py │ ├── examples/ │ ├── basic_usage.py │ └── advanced_usage.py │ ├── .env.example ├── .gitignore ├── LICENSE ├── MANIFEST.in ├── pyproject.toml ├── README.md └── requirements.txt