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.0a28.tar.gz (52.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.0a28-py3-none-any.whl (72.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for cognite-sdk-1.0.0a28.tar.gz
Algorithm Hash digest
SHA256 11492e90a7aa5b95e87c843af6a4970ac94e17036b0061e2cf9325a6c897ab1d
MD5 70fd7101e7b5f572b8b1a58da717a9cf
BLAKE2b-256 72414596202d6ca9620cfc27e2d6451bff9f2e5971c1897b2362e7dda520e309

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for cognite_sdk-1.0.0a28-py3-none-any.whl
Algorithm Hash digest
SHA256 e401c69994e33b53fe90bab7253c0dc12b58738c1995f5833a56259d05f2df9c
MD5 840c85c307b77f0360e095c34f3b84e8
BLAKE2b-256 e3b80ed9735591a5395f8ae473f287a9b2b4cf41c5fc07a075f4a7c758af0d9a

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