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-2.5.0.tar.gz (97.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-2.5.0-py3-none-any.whl (134.5 kB view details)

Uploaded Python 3

File details

Details for the file cognite-sdk-2.5.0.tar.gz.

File metadata

  • Download URL: cognite-sdk-2.5.0.tar.gz
  • Upload date:
  • Size: 97.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/49.6.0 requests-toolbelt/0.9.1 tqdm/4.44.1 CPython/3.7.9

File hashes

Hashes for cognite-sdk-2.5.0.tar.gz
Algorithm Hash digest
SHA256 4f11c97c91f753c2661c0f09b2a80523468a24e03439e4741e818f904e16710e
MD5 d9c4155f93ca2aa4747715b14821e36d
BLAKE2b-256 d88d8b7284f3508e0ed392c35ddaa37d8edf8fcfe9864cff8421a32743b6d0e2

See more details on using hashes here.

File details

Details for the file cognite_sdk-2.5.0-py3-none-any.whl.

File metadata

  • Download URL: cognite_sdk-2.5.0-py3-none-any.whl
  • Upload date:
  • Size: 134.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/49.6.0 requests-toolbelt/0.9.1 tqdm/4.44.1 CPython/3.7.9

File hashes

Hashes for cognite_sdk-2.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d15f30bacce32c55adb345d5d3728dd335eaacc441de9f082b7ffc5d7f1a2547
MD5 bfcdc5e5c623807adf5af9088b63f752
BLAKE2b-256 9ae8813758bfce80db2777f9495e4c89b305dd10163b8f1c4431e3c7d02edd1e

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