Metadata-Version: 2.4
Name: yellowdog-sdk
Version: 13.7.2
Summary: SDK for the YellowDog Platform
Author-email: YellowDog Limited <support@yellowdog.co>
Project-URL: Homepage, https://yellowdog.co
Project-URL: Source, https://github.com/yellowdog/yellowdog-sdk-python-public
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: License :: OSI Approved :: Apache Software License
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: jsons<2,>=1.4.0
Requires-Dist: requests<3,>=2.25.0
Requires-Dist: urllib3<2,>=1.26.0; python_version < "3.12"
Requires-Dist: urllib3<3,>=2.0.0; python_version >= "3.12"
Requires-Dist: python-dispatch==0.2.3
Requires-Dist: cancel-token==0.1.6
Requires-Dist: isodate<1,>=0.6.1
Dynamic: license-file

# YellowDog SDK (Python)

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

## Usage

Please refer to [the full documentation](https://docs.yellowdog.co/#/sdk/python-sdk).

## Advanced

### Building From Source

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

```shell
./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:

```shell
sudo apt-get install python3.9-dev
```

### Testing Against Multiple Python Versions

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

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

```shell
./scripts/test
```
