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

Uploaded Source

Built Distribution

commercetools-14.0.0b3-py3-none-any.whl (746.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: commercetools-14.0.0b3.tar.gz
  • Upload date:
  • Size: 373.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/54.1.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

File hashes

Hashes for commercetools-14.0.0b3.tar.gz
Algorithm Hash digest
SHA256 05cf5cd0ddec680a312f7a12a44cf301a54bea55632b21a12364e4d349ac5d2e
MD5 37ee32daaa86eec4fdb7d12d7382b411
BLAKE2b-256 84bc63256a1ac40d8ed0a751fe4d4ac8eb5ada5c37a2e573098bc6054b831c97

See more details on using hashes here.

File details

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

File metadata

  • Download URL: commercetools-14.0.0b3-py3-none-any.whl
  • Upload date:
  • Size: 746.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/54.1.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

File hashes

Hashes for commercetools-14.0.0b3-py3-none-any.whl
Algorithm Hash digest
SHA256 b9a8d94c6ab74c29e135a8315639570698dd189985951a6f18b6008e0345146b
MD5 391ca6bfbe352a72f291ef3f74cc2a8b
BLAKE2b-256 4596ca07b57eb1029b124d3d710c5a58b9485bdf40e257051be8774797cc29a3

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