============================================
yellowdog-sdk documentation
============================================
Release v\ |version|.

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

.. contents::
    :depth: 3

Requirements
============

Our SDK is tested against all supported versions of Python: https://devguide.python.org/versions/#supported-versions

Versions as early as Python 3.7 should work, but we recommend using a version of Python that is not end-of-life.

Download & Install
==================

Add yellowdog-sdk to your `requirements.txt`:

    yellowdog-sdk==\ |version|

Then install with:

    $ pip install -r requirements.txt

Imports are from the ``yellowdog_client`` package, e.g.:

.. code-block:: python

    from yellowdog_client import PlatformClient

Usage
=====

.. automodule:: yellowdog_client

API Reference
=============
.. toctree::

   api

Contact
=======

`YellowDog Limited`

https://yellowdog.co/

support@yellowdog.co

License
=======

Please contact support@yellowdog.co for license details.