Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.mantlebio.com/llms.txt

Use this file to discover all available pages before exploring further.

The Mantle SDK (software development kit) is a Python package that provides a set of tools for interacting with the Mantle Database and Mantle Pipeline runs. The Mantle SDK provides a set of functions for authenticating with Mantle, getting data entities from the Mantle Database as Python objects, downloading files from data entities, and more. It is designed to be used within Mantle Notebooks, Jupyter notebooks, and Python scripts. This guide walks through some examples of common uses of the SDK. For the full documentation, visit sdk.mantlebio.com.

​
Installation

The only prerequisite for installing the Mantle SDK is Python 3.6+. The Mantle SDK can be installed using pip: 
pip install mantlebio

​
Usage

To instantiate a Mantle client, use: 
import mantlebio

mantle = mantlebio.MantleClient()

Interact with the database

Fetch from or push to your Mantle Database.

Interact with pipeline runs

Get outputs from Mantle Pipeline runs.