YellowDog SDK (Python)

The YellowDog SDK allows you to integrate the YellowDog Platform into your Python applications.

Usage

Please refer to the full documentation.

Advanced

Building From Source

If you wish to modify the SDK, you can build it from source. You must have Python 3.15 installed:

./scripts/setup

Pycharm may then be configured by adding .tox/dev/bin/python as the interpreter.

Debugging

When debugging the SDK via Pycharm, Pycharm will offer to install the CPython extensions to speed up debugging.

In order for this to work on Ubuntu, you need to first have the dev package for the version of Python you are debugging against.

For example:

sudo apt-get install python3.11-dev

Testing Against Multiple Python Versions

# Add the deadsnakes PPA
sudo add-apt-repository ppa:deadsnakes/ppa
# Update package indexes
sudo apt-get update
# Install all tested versions of Python                                              
sudo apt-get install python3.11 python3.12 python3.13 python3.14 python3.15                                                 

Assuming you have already run the setup script and installed tox, you can then run all tests:

./scripts/test