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.18.0.tar.gz (118.4 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.18.0-py3-none-any.whl (153.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cognite-sdk-2.18.0.tar.gz
  • Upload date:
  • Size: 118.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/56.0.0 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.8.9

File hashes

Hashes for cognite-sdk-2.18.0.tar.gz
Algorithm Hash digest
SHA256 4b3d7b42bc6fe7b9fa0b8cb4500323682ceab86e349c79a3332ff5e57036a788
MD5 e84cc365e26e2d21137a5f67d07a7ffc
BLAKE2b-256 bbd0b1bd00c021d7933ed0cf71b6cca93ed5b811ad4d7615949798a7ed0d7953

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cognite_sdk-2.18.0-py3-none-any.whl
  • Upload date:
  • Size: 153.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/56.0.0 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.8.9

File hashes

Hashes for cognite_sdk-2.18.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3ef283bb26be07e743d6851ff873abcf77c2c3887fb4a47e4a281f173a61bd50
MD5 2534c6334058dab39852ff5b8accc07f
BLAKE2b-256 881932605de34d825f620edc3d5d10b0cb9450564724c79e7a89077ed66c2f81

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