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 mostly generated using the commercetools api RAML file and uses the attr library for the dataobjects and marshmallow for the serialization and deserialization steps.

Installation

pip install commercetools

Example

from commercetools import Client

client = Client(
    project_key="<your-project-key>",
    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.products.get_by_id("00633d11-c5bb-434e-b132-73f7e130b4e3")
print(product)

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

export CTP_PROJECT_KEY="<project key>"
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 import Client

client = Client()

product = client.products.get_by_id("00633d11-c5bb-434e-b132-73f7e130b4e3")
print(product)

Releasing

To release this package first (pip) install bumpversion 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

Then go to Azure Pipelines and wait for the build to create an artifact. Once the build succeeded go to Releases and create a release with the correct artifact. This will release the package 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-6.2.0.tar.gz (227.9 kB view details)

Uploaded Source

Built Distribution

commercetools-6.2.0-py3-none-any.whl (304.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: commercetools-6.2.0.tar.gz
  • Upload date:
  • Size: 227.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.6

File hashes

Hashes for commercetools-6.2.0.tar.gz
Algorithm Hash digest
SHA256 015f0aa78b9bcf50221b2d1ea68881f17eb5819ed43835f6fbc9b46c1be48811
MD5 93bedd0b5a5b2df6f7abb99241b4b999
BLAKE2b-256 61dc266d7a5a536a898eb3db60a10899317bcee39b7a2b4b096503320fcc74d1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: commercetools-6.2.0-py3-none-any.whl
  • Upload date:
  • Size: 304.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.6

File hashes

Hashes for commercetools-6.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 31c4ac71516e9463b9e522b0ba141398cf3ce66a86eb786daf2e088ed621a215
MD5 5cfa79154d74d4a233cd087060629de8
BLAKE2b-256 389239965dc754222c86d6969689a2e07272ead69ef0f1f37799f80c8e0e1283

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