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.0b11.tar.gz (374.4 kB view details)

Uploaded Source

Built Distribution

commercetools-14.0.0b11-py3-none-any.whl (751.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: commercetools-14.0.0b11.tar.gz
  • Upload date:
  • Size: 374.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.7

File hashes

Hashes for commercetools-14.0.0b11.tar.gz
Algorithm Hash digest
SHA256 4763c6f9254e28d4d3ae387e13860a649df945f6dd4eb885e36c16efb7fa0a36
MD5 463dccbfb9d96ee1c4d5e6fbb0f1e5e6
BLAKE2b-256 944a20d1faa1d0eb6f446a8ad608386f589649415c0690bda8cae41a517f4130

See more details on using hashes here.

File details

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

File metadata

  • Download URL: commercetools-14.0.0b11-py3-none-any.whl
  • Upload date:
  • Size: 751.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.7

File hashes

Hashes for commercetools-14.0.0b11-py3-none-any.whl
Algorithm Hash digest
SHA256 2bd81731fb795c48e18de925a99ce214e93210835f59ba77f3e2a09b30c879b2
MD5 c9b42e52c2dd34e2fbcba02bdef8901f
BLAKE2b-256 cd50c3e65e085c7afb07c5d6b97d4867a6689fdc82fc3b5d23ffcf1d716a15c6

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