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.30.0.tar.gz (122.6 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.30.0-py3-none-any.whl (157.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for cognite-sdk-core-2.30.0.tar.gz
Algorithm Hash digest
SHA256 8f9dd0448f4af5bf758b03c01f169bb84cbcfaf53af615b3af6312b253a72b0f
MD5 7921d08d9254580ef140a83d2869faa4
BLAKE2b-256 1caddb6e3789f0af205e438a1e2d7d81b8ed3e0e06663bca1d47bb27c52d49dc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cognite_sdk_core-2.30.0-py3-none-any.whl
  • Upload date:
  • Size: 157.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/57.4.0 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.8.11

File hashes

Hashes for cognite_sdk_core-2.30.0-py3-none-any.whl
Algorithm Hash digest
SHA256 40f4beaebe1f5a7b9fb82536d097febee2afbeb6b35bc449a63e2464c2b82168
MD5 642ada27790348211689e2bffa5b78b7
BLAKE2b-256 3d2f8a70e61515210ca007113629e887686a70a8c909521a9febf56b5172b6dd

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