Skip to main content

Toucan data SDK

Project description

Pypi-v Pypi-pyversions Pypi-l Pypi-wheel GitHub Actions codecov

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

toucan_data_sdk-7.5.0.tar.gz (45.9 kB view hashes)

Uploaded source

Built Distribution

toucan_data_sdk-7.5.0-py3-none-any.whl (62.3 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page