Mind Lake SDK
  • Overview
  • Get started
    • Tutorial step-by-step
    • TypeScript Quick-Start
    • Python Quick-Start
  • Use Cases
    • 1-Single User with Structured Data
    • 2-Single User with UnStructured Data
    • 3-Multi Users with Permission Sharing
  • Glossary
  • TYPESCRIPT API REFERENCE
    • MindLake
    • MindLake.DataLake
    • MindLake.Cryptor
    • MindLake.Permission
    • Return Code
  • PYTHON API REFERENCE
    • MindLake
    • MindLake.DataLake
    • MindLake.Cryptor
    • MindLake.Permission
    • Return Code
Powered by GitBook
On this page
  • Installation
  • Preparation
  • SDK Quick Start
  • More examples
  • Synopsis

Get started

Get started using the Mind Lake SDK.

PreviousOverviewNextTutorial step-by-step

Last updated 1 year ago

The TypeScript/Python SDK enables developers to execute SQL statements freely and perform encryption and decryption operations on specific data.

Installation

Install with package:

  • npm: npm install mind-lake-sdk

  • yarn: yarn add mind-lake-sdk

Install from source:

Install with package:

pip install mindlakesdk

Install from source:

Preparation

If you have TypeScript or Python environment configured in your local environment, you can jump to "Quick Start" (next section) directly.

Otherwise, you can follow a step-to-step tutorial to prepare the environment first.

Step-by-step tutorial:

Step-by-step tutorial:

SDK Quick Start

More examples

More examples are welcome from the community. Please contact us.

Synopsis

The SDK offers a variety of APIs:

API
Description

The general interfaces that apply to entire SDK, including the entry point `connect` method to connect to Mind Lake and managing user accounts as well as encryption keys.

Managing the data tables and enabling execution of SQL queries.

Encrypting and decrypting data

Granting permission of decryption to other users for sharing

The SDK developer has a few more to help understand.

MindLake < | >

MindLake.DataLake < | >

MindLake.Cryptor < | >

MindLake.Permission < | >

Checkout TypeScript Quick-start example

TypeScript Quick-Start

Checkout Python Quick-start example

Python Quick-Start

https://github.com/mind-network/mind-lake-sdk-typescript
https://github.com/mind-network/mind-lake-sdk-python
https://github.com/mind-network/mind-lake-sdk-typescript/blob/main/tutorial/README.md
https://github.com/mind-network/mind-lake-sdk-python/blob/main/tutorial/README.md
examples
TypeScript
Python
TypeScript
Python
TypeScript
Python
TypeScript
Python