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.3.0.tar.gz (32.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

plytix_pim_client-1.3.0-py3-none-any.whl (83.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: plytix_pim_client-1.3.0.tar.gz
  • Upload date:
  • Size: 32.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for plytix_pim_client-1.3.0.tar.gz
Algorithm Hash digest
SHA256 0d258cac189581fa8c1eb21d4e2cca66fce6801a490967ca88ca3c808e00485d
MD5 c046c13598157da20abb51d36961f9b9
BLAKE2b-256 54f01be41047a7d4460f5c823c6ad3e9d0f4dd4b85aec901774079ac04f1832b

See more details on using hashes here.

Provenance

The following attestation bundles were made for plytix_pim_client-1.3.0.tar.gz:

Publisher: publish-to-pypi.yml on TheTelematic/plytix-pim-client

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

File hashes

Hashes for plytix_pim_client-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 98c9b49a645493ed622b64c90d3eb56ddd007ed33243d7bb10e5ae76f260387e
MD5 7fcaa5a0400ace90571834f7326a8d68
BLAKE2b-256 49d5202b35ae2a6052d3136dddbdb2b78a99c5b302184639fec432cd90618627

See more details on using hashes here.

Provenance

The following attestation bundles were made for plytix_pim_client-1.3.0-py3-none-any.whl:

Publisher: publish-to-pypi.yml on TheTelematic/plytix-pim-client

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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