Get Started with the Shade Python SDK

Easily manage and interact with your data in Shade via our Python SDK

Shade offers a full-featured python SDK that enables you to access any part of your workspace including files, metadata, members, searches, and more.

Installing the Shade Python SDK

Our SDK supports Python 3.8+. Once you have successfully installed Python on your machine, you can install below:

pip install shade-python-sdk

Authenticating with the Python SDK

You can obtain an API key for the Shade Python SDK from your workspace and generating a new key.

Please keep in mind that this is a secret key and should not be shared publically or stored in a public repository.

You can access your API Keys by going to Settings > API Keys

Initializing Shade

You can easily initialize the Shade SDK by initializing a Shade object. This will authenticate and authorize as your user - whatever you have access to, the object will have access to.

API_KEY = 'sk....'
REMOTE_URL = 'https://api.shade.inc'
shade = Shade(remote_url=REMOTE_URL, api_key=API_KEY)