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.sphere.io",
    token_url="https://auth.sphere.io",
)

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://auth.sphere.io"
export CTP_API_URL="https://api.sphere.io"
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-14.0.0b8.tar.gz (373.5 kB view details)

Uploaded Source

Built Distribution

commercetools-14.0.0b8-py3-none-any.whl (750.6 kB view details)

Uploaded Python 3

File details

Details for the file commercetools-14.0.0b8.tar.gz.

File metadata

  • Download URL: commercetools-14.0.0b8.tar.gz
  • Upload date:
  • Size: 373.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.5

File hashes

Hashes for commercetools-14.0.0b8.tar.gz
Algorithm Hash digest
SHA256 e8903153defd8395f445bda58b93293e2b9c7f1cf75d9b2fc33589af12af131d
MD5 311ce61df869b9b879bdaf4cdcb3858c
BLAKE2b-256 f6c78a6e8db97b949125f50db90ff8c8c0876955fbb755c119c28ccb885e766e

See more details on using hashes here.

File details

Details for the file commercetools-14.0.0b8-py3-none-any.whl.

File metadata

  • Download URL: commercetools-14.0.0b8-py3-none-any.whl
  • Upload date:
  • Size: 750.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.5

File hashes

Hashes for commercetools-14.0.0b8-py3-none-any.whl
Algorithm Hash digest
SHA256 b809247a679cdbe2c13f820384a3ada4443b0fc45da9fbb4e192d8e51e7fd43d
MD5 f508f2afa9e72a9f4cc3ce3ae94db3de
BLAKE2b-256 c3047999f61cc04be5efe514cd7cef423aa7443ce87a05ed048cbc0189d22134

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