Skip to content

cognitedata/cognite-sdk-python

Folders and files

NameName
Last commit message
Last commit date
Jun 25, 2019
Oct 1, 2019
Sep 20, 2019
Sep 17, 2019
Oct 1, 2019
Mar 11, 2019
Jul 3, 2019
Nov 27, 2018
Oct 1, 2019
Jun 17, 2019
Sep 19, 2019
Apr 11, 2018
Sep 18, 2018
Aug 19, 2019
Aug 19, 2019
Sep 5, 2019
Aug 15, 2019
May 29, 2019
Aug 28, 2019
Mar 21, 2019
Jun 1, 2019
Jun 1, 2019
Aug 19, 2019

Repository files navigation

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.