Upgrade Your Python SDK

Catalyst constantly strives to provide you with the latest, most secure, and efficient SDK packages to streamline your development process. We also upgrade our SDK support based on the upgrades in the technology. That is, when a new version of Python is released, Catalyst ensures we implement it in our SDK toolkit.

This means that from time to time, Catalyst will upgrade its SDK version to provide you with the best coding support. We recommend keeping up with the latest Catalyst SDK updates and bug fixes through our Release Notes and upgrading to the latest versions as they become available. Our SDK updates align with official Python releases, incorporating their latest enhancements while phasing out deprecated versions. Additionally, we continuously introduce new components and features to enhance the SDK experience.

Note: If an immediate upgrade of your SDK is required due to deprecating an old SDK version, we will ensure you are notified on time via email to perform the necessary upgrades. Generally, it's highly recommended that you always upgrade your SDK to the latest version.

You can upgrade your SDK globally and within Python functions. We will be discussing about steps to upgrade the SDK in both the places in this help doc.

Note: When you upgrade the SDK globally, the existing functions won't automatically reflect the updated version. To apply the global version, you need to remove the specified version from the requirements.txt file of each function.

Upgrade SDK Globally

To upgrade the Catalyst Python SDK globally, you can use the commands below from any directory in your terminal : Install a Specific Package

To install a specific Python SDK version’s package, execute the following command. Please ensure to replace the version number of the SDK package with the one you require.

copy
pip install zcatalyst-sdk==0.0.2

Note:
  1. It is always recommended that you install the latest version of the SDK rather than a specific version.
  2. By default, while executing Python functions, the function considers the SDK package listed in the requirements.txt file. If want to use the SDK that is installed globally, please remove the SDK package from requirements.txt file.

Install Latest Version

Installing the latest version of the SDK gives you access to the newest features and includes all recent bug fixes. To install the latest available version of the SDK at any time, execute the following command:

copy
pip install zcatalyst-sdk

Upgrade SDK in a Function

To upgrade the Catalyst Python SDK for a specific function, please follow the below steps:

  1. Launch your terminal and navigate to the Python function’s source directory. For example, consider you have a Catalyst project named “Pets Conglomerate” installed through the CLI in your system: /Users/user/apps/petsConglomerate. In this project, you have a function named “dogs_spotted”. You need to navigate to the function’s source directory, which would appear like this: /Users/user/apps/petsConglomerate/functions/dogs_spotted

  2. Open the requirements.txt file in this function’s directory, and update the version of the Python SDK and save the file.

    For example : zcatalyst-sdk==1.0.0rc1

  3. Execute the below command to make sure the updated SDK version is reflected in your CLI instance.

copy
pip install -r requirements.txt

This command ensures the updates in the latest version are reflected in the CLI right away.

Last Updated 2025-12-04 16:23:00 +0530 IST