Getting started

How to get started with the Mindkosh SDK

Github repo

Example scripts

PyPi

Setting up the SDK

The first thing you need to setup the SDK is a private access token. You can grab one by emailing us at [email protected] or getting in touch with us over Slack/phone.

Note that SDK access is only available for paid users.

Next, you'd want to install the SDK. Mindkosh SDK is available as a Pypi package can be installed using pip like so:

pip install mindkosh

The SDK has been tested on Python 3.9 . While it may work on other versions, those haven't been tested and compatibility is not guaranteed. It is recommended that you install mindkosh in a separate python environment.

Initializing the client

To do anything with the SDK, you first need to create a client using the SDK token. This can be done like so:

## Initialize the client
client = mindkosh.Client(
    token = <"Your token here">,
)

You can check if this succeeded by fetching a list of all the tasks in your workspace.

tasks = client.task.get()
print(f"Found {len(tasks)} tasks")
for task in tasks:
    print(task.name)