Skip to main content

SDK for Commercetools

Project description

This is an unofficial Python SDK for the Commercetools platform. It only supports Python 3.6+ and uses type annotation for an improved development experience.

The API is generated using the commercetools api RAML file and uses marshmallow for the serialization and deserialization.

Installation

pip install commercetools

Example

from commercetools.platform import Client

client = Client(
    client_id="<your-client-id>",
    client_secret="<your-client-secret>",
    scope=["<scopes>"],
    url="https://api.europe-west1.gcp.commercetools.com",
    token_url="https://auth.europe-west1.gcp.commercetools.com",
)

product = (
    client
    .with_project_key("<your-project-key>")
    .products()
    .with_id("00633d11-c5bb-434e-b132-73f7e130b4e3")
    .get())
print(product)

The client can also be configured by setting the following environment variables:

export CTP_CLIENT_SECRET="<client secret>"
export CTP_CLIENT_ID="<client id>"
export CTP_AUTH_URL="https://api.europe-west1.gcp.commercetools.com"
export CTP_API_URL="https://auth.europe-west1.gcp.commercetools.com"
export CTP_SCOPES="<comma seperated list of scopes>"

And then constructing a client without arguments:

from commercetools.platform import Client

client = Client()

product = (
    client
    .with_project_key("<your-project-key>")
    .products()
    .with_id("00633d11-c5bb-434e-b132-73f7e130b4e3")
    .get())

print(product)

Releasing

To release this package first (pip) install bump2version and update the CHANGES file. Then update the version (either major/minor/patch depending on the change)

bumpversion --tag <major,minor,patch>

bumpversion is naive because it string replaces, so do a sanity check it didn’t accidentally update a Pypi dependency. If not, push the code:

git push --follow-tags

We use GitHub actions so make sure the build succeeds and then go to the tags tab (https://github.com/labd/commercetools-python-sdk/tags).

Click the dots to trigger a release action. Copy the changelog items in the release description and enter the release version. This will upload the release to PyPi.

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

commercetools-2022.6.4.tar.gz (519.4 kB view details)

Uploaded Source

Built Distribution

commercetools-2022.6.4-py3-none-any.whl (956.4 kB view details)

Uploaded Python 3

File details

Details for the file commercetools-2022.6.4.tar.gz.

File metadata

  • Download URL: commercetools-2022.6.4.tar.gz
  • Upload date:
  • Size: 519.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.15

File hashes

Hashes for commercetools-2022.6.4.tar.gz
Algorithm Hash digest
SHA256 366830a3f471e42b8bd6ef67fbef28d0030f48b542f80cc24997f52f38254384
MD5 60ae55af1cea12cee344dcfe797caa40
BLAKE2b-256 798c0de1b2b7eb96fce14ba546550cb08438f821e0cc514cae66c7ffb6499022

See more details on using hashes here.

File details

Details for the file commercetools-2022.6.4-py3-none-any.whl.

File metadata

File hashes

Hashes for commercetools-2022.6.4-py3-none-any.whl
Algorithm Hash digest
SHA256 137130e596272dedf95fc78424eb4c1714236b039617b33bdd63982dd4510615
MD5 012bdac07c9738934fb2c4d69b414e5b
BLAKE2b-256 bf3dec6f52fdff35d1756f31aec084c7db4eab4e65880f5ded8afc54d1a8a94f

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