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

Uploaded Source

Built Distribution

commercetools-14.0.0b10-py3-none-any.whl (750.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: commercetools-14.0.0b10.tar.gz
  • Upload date:
  • Size: 373.8 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.0b10.tar.gz
Algorithm Hash digest
SHA256 99e6977ae3573c7e6997d4298a364946798abc7503e5cf5a54579f6ef7d1bf9b
MD5 c0223da9a470c53efb31bd8e6e19b654
BLAKE2b-256 51a162342408ec21efd8177f6174c82c533acaa6a3a7ce6bedab5c9ee1e1a2fe

See more details on using hashes here.

File details

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

File metadata

  • Download URL: commercetools-14.0.0b10-py3-none-any.whl
  • Upload date:
  • Size: 750.8 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.0b10-py3-none-any.whl
Algorithm Hash digest
SHA256 bf3996f8ddccc71c403d78fff26d8d550a6c24ee228fdb52918c210c9493918f
MD5 1b893d5ee810e4ff02a36fcb25ba05c8
BLAKE2b-256 7e0d5c60bf9aa51fc63bd94ef52bf9593a3be2f194828e7bd3fe2455b24543b6

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