toucan-data-sdk 7.5.0

Toucan data SDK

Toucan Data SDK

Develop your Toucan Toco data pipeline from the confort of your favorite environment.

Installation

For usage: pip install toucan_data_sdk

For dev:

Install the module in editable mode and with test requirements: pip install -e '.[test]'

Usage

Get data sources

import getpass
from toucan_data_sdk import ToucanDataSdk

instance_url = 'https://api-demo.toucantoco.com'
auth = ('<username>', getpass.getpass())

sdk = ToucanDataSdk(instance_url, small_app='demo', auth=auth, enable_cache=True)
dfs = sdk.get_dfs()

API

ToucanDataSdk class

ToucanDataSdk.sdk

• property,
• uses the client to send a request to the back end to send the data sources as DataFrames,
• uses an internal cache.

ToucanDataSdk.invalidate_cache()

Invalidates the cache. Next time you will access to the sdk property, a request will be sent to the client.

Utils

cf. https://docs.toucantoco.com/concepteur/data-sources/00-generalities.html#utility-functions

For example:

from toucan_data_sdk.utils import add_missing_row

Development

Makefile

Use the makefile to test, build...

$ make test

Development

You need to install poetry either globally or in a virtualenv. Then run make install