Skip to main content

Client library for Cognite Data Fusion (CDF)

Project description

Cognite logo

Cognite Python SDK

build codecov Documentation Status PyPI version tox Code style: black

This is the Cognite Python SDK for developers and data scientists working with Cognite Data Fusion (CDF). The package is tightly integrated with pandas, and helps you work easily and efficiently with data in Cognite Data Fusion (CDF).

Documentation

Prerequisites

In order to start using the Python SDK, you need

  • Python3 (>= 3.5) and pip
  • An API key. Never include the API key directly in the code or upload the key to github. Instead, set the API key as an environment variable. See the usage example for how to authenticate with the API key.

This is how you set the API key as an environment variable on Mac OS and Linux:

$ export COGNITE_API_KEY=<your API key>

On Windows, you can follows these instructions to set the API key as an environment variable.

Installation

To install this package:

$ pip install cognite-sdk

To install this package without the pandas and NumPy support:

$ pip install cognite-sdk-core

Examples

For a collection of scripts and Jupyter Notebooks that explain how to perform various tasks in Cognite Data Fusion (CDF) using Python, see the GitHub repository here

Changelog

Wondering about upcoming or previous changes to the SDK? Take a look at the CHANGELOG.

Contributing

Want to contribute? Check out CONTRIBUTING.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

cognite-sdk-1.0.0a34.tar.gz (54.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cognite_sdk-1.0.0a34-py3-none-any.whl (74.7 kB view details)

Uploaded Python 3

File details

Details for the file cognite-sdk-1.0.0a34.tar.gz.

File metadata

  • Download URL: cognite-sdk-1.0.0a34.tar.gz
  • Upload date:
  • Size: 54.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.2

File hashes

Hashes for cognite-sdk-1.0.0a34.tar.gz
Algorithm Hash digest
SHA256 c2940fb58cc66edff7ca5217f38a964d55200b533c93853c967f81971ab10b62
MD5 221a1c372e995513b2c640a9a8448fe0
BLAKE2b-256 23e4f84d2a481960e54dc4286bc4b78c5f124e9631689a0f74b75aa2a5e06dfe

See more details on using hashes here.

File details

Details for the file cognite_sdk-1.0.0a34-py3-none-any.whl.

File metadata

  • Download URL: cognite_sdk-1.0.0a34-py3-none-any.whl
  • Upload date:
  • Size: 74.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.2

File hashes

Hashes for cognite_sdk-1.0.0a34-py3-none-any.whl
Algorithm Hash digest
SHA256 e1bdcad929227a2e3510db64929f311b455273ef1242367a68be27fb864bb3b2
MD5 175fb617280d90f30d33ae4386ae4489
BLAKE2b-256 fe930b274328f7464450b4e54e5b1d73fd34ab6f4d2eef606bf8b168b0dcb637

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page