Skip to content

README.md

Latest commit

 

History

History
53 lines (36 loc) · 1022 Bytes

README.md

File metadata and controls

53 lines (36 loc) · 1022 Bytes

Python client for UnderstandLabs

PyPi page link -- version

This is the official Python SDK for UnderstandLabs

Getting Started

Install

pip install understand-sdk

# or
# poetry add understand-sdk

Configuration

from understand_sdk.client import UnderstandPublicClient

# contact us at it@understandlabs.com for getting API key
client = UnderstandPublicClient(api_key="api key")

Usage

from understand_sdk.story import StoryWithChannels

# create new story object
story = StoryWithChannels(
    title="A new awesome story",
    channels=[
        "general"
    ],
    slides=[
        # add your slides
    ]
)

# push a new story to Understand platform
client.create_story(story)

Getting Help/Support

If you need help reach out to us at it@understandlabs.com.

License

Licensed under the MIT license, see LICENSE