Skip to main content

An HTTP client in Python for Plytix PIM API.

Project description

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

  • Python 3.11+

Features

  • Synchronous and asynchronous clients
  • Automatic token refresh
  • Automatic rate limiting
  • Automatic pagination
  • Automatic error handling
  • Automatic request retries
  • API docs fully covered*
  • Configurable Response Cooldown

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:

  • products
    • assets
    • attributes
      • groups
    • categories
    • families
      • attributes
    • relationships
    • variants
  • assets
    • categories

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

plytix_pim_client-1.0.0.tar.gz (31.0 kB view details)

Uploaded Source

Built Distribution

plytix_pim_client-1.0.0-py3-none-any.whl (81.0 kB view details)

Uploaded Python 3

File details

Details for the file plytix_pim_client-1.0.0.tar.gz.

File metadata

  • Download URL: plytix_pim_client-1.0.0.tar.gz
  • Upload date:
  • Size: 31.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for plytix_pim_client-1.0.0.tar.gz
Algorithm Hash digest
SHA256 f9a4b35375c6fdfdad994b51ae6cfb0a29ad19937d222867c2f807fe7c994357
MD5 a993d5646944341e2122066a35092c5e
BLAKE2b-256 1c89ad30778dff74b07d6efbfe616390e818cdbf34e4d1ecfcd2afd0e76cc19a

See more details on using hashes here.

File details

Details for the file plytix_pim_client-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for plytix_pim_client-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 089ce2de4553bbfd03ea2956bd833e38ca3f6aa4dcbb0d989c059f2df2d61280
MD5 5d89d04683bbdb9d00cbcb75e1fa55c0
BLAKE2b-256 2d3f63f6855e18064ed9a9774b2b41455ae682426d613c5087fde4b037bc6b8c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page