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-core-2.0.0.tar.gz (94.5 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_core-2.0.0-py3-none-any.whl (131.6 kB view details)

Uploaded Python 3

File details

Details for the file cognite-sdk-core-2.0.0.tar.gz.

File metadata

  • Download URL: cognite-sdk-core-2.0.0.tar.gz
  • Upload date:
  • Size: 94.5 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.2.0 requests-toolbelt/0.9.1 tqdm/4.44.1 CPython/3.7.8

File hashes

Hashes for cognite-sdk-core-2.0.0.tar.gz
Algorithm Hash digest
SHA256 4589857879b61cb53cbd0a8590d38db645ddeda986cc5b78ee6fa3fc92cd8bd9
MD5 caf05e62d7eb46a811d380f62ccc7ed1
BLAKE2b-256 0b811009dcbaece6d0e85b9316413da68dbe89a628e99b93c7572176bb82fd32

See more details on using hashes here.

File details

Details for the file cognite_sdk_core-2.0.0-py3-none-any.whl.

File metadata

  • Download URL: cognite_sdk_core-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 131.6 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.2.0 requests-toolbelt/0.9.1 tqdm/4.44.1 CPython/3.7.8

File hashes

Hashes for cognite_sdk_core-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5e83a7ba73b21eb5f6bf7137bcf5e44b98a416e412d8fbb9007e2edb79ef83e7
MD5 bfbac9d447fea55013df31bb794cec8b
BLAKE2b-256 20cfb5a46a554f14119d77452a7e7af4577ee178ba4174e140b499ae2ec6b723

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