TheTelematic / plytix-pim-client

An HTTP client in Python for Plytix PIM API.
MIT License
3 stars 0 forks source link

plytix-pim-client

An HTTP client in Python for Plytix PIM API.

PyPI PyPI - Downloads GitHub Action Publish to PyPI

API documentation: https://apidocs.plytix.com

Example

Installation

pip install plytix-pim-client

PyPI: https://pypi.org/project/plytix-pim-client/

Requirements

Features

Usage

Synchronous client

from plytix_pim_client import PlytixSync

# Set the environment variables PLYTIX_API_KEY and PLYTIX_API_PASSWORD
plytix = PlytixSync()

Asynchronous client

from plytix_pim_client import PlytixAsync

# Set the environment variables PLYTIX_API_KEY and PLYTIX_API_PASSWORD
plytix = PlytixAsync()

All methods are available in both synchronous and asynchronous clients with the same I/O interface. For the sake of simplicity, only the synchronous client is shown in the examples.

Available resources

Any of the following resources can be accessed through the client:

Each resource has specific methods to interact with the API. If you use an IDE with code completion, you can see all available methods. If you find a method that is not available or confusing, please open an issue. Also, you may have a look to the integration tests for more examples.

Examples

Create a product

from plytix_pim_client import PlytixSync

plytix = PlytixSync()

plytix.products.create_product(sku="My First Product", label="My First Product")

Create a product family

from plytix_pim_client import PlytixSync

plytix = PlytixSync()

plytix.products.families.create_family(name="My First Family")

* Known issues

Check out the open Issues with "bug" label.