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/oauth/token",
)

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-5.0.0.tar.gz (221.9 kB view details)

Uploaded Source

Built Distribution

commercetools-5.0.0-py3-none-any.whl (295.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: commercetools-5.0.0.tar.gz
  • Upload date:
  • Size: 221.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.37.0 CPython/3.7.5

File hashes

Hashes for commercetools-5.0.0.tar.gz
Algorithm Hash digest
SHA256 5f97e8b4e608f1008837caeba23e88a4384ac2f29ec37360830db2c8ba1b7765
MD5 8acb1d364f1a2fa5d259ecc6061035d0
BLAKE2b-256 1c216e35295545ecd50c1122c625bceb131cc2244cecc0642accb301fc3e551a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: commercetools-5.0.0-py3-none-any.whl
  • Upload date:
  • Size: 295.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.37.0 CPython/3.7.5

File hashes

Hashes for commercetools-5.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7d461bae80942828830bc2b3b324eec00dcbeccfef25aae7e15bf088ac9b4d07
MD5 a498a3a3bb0385cb78351eda17678c5c
BLAKE2b-256 8746b398d893aa882c5aedeee8ba077d0568479706b3070de0940c1850a42e6c

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