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-1.0.0a26.tar.gz (52.3 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-1.0.0a26-py3-none-any.whl (72.2 kB view details)

Uploaded Python 3

File details

Details for the file cognite-sdk-1.0.0a26.tar.gz.

File metadata

  • Download URL: cognite-sdk-1.0.0a26.tar.gz
  • Upload date:
  • Size: 52.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.2

File hashes

Hashes for cognite-sdk-1.0.0a26.tar.gz
Algorithm Hash digest
SHA256 fa8b3a4b5b1a89805ecf3ded133fe288e1978bdf4fc8bb23fdeea3fde1a6f346
MD5 0955f2077a374e220b227ecfedbc6245
BLAKE2b-256 eee8e998bc8ef1d2876d9f6ccf1c74e2705a85b37d7d965d39545b553a9e424d

See more details on using hashes here.

File details

Details for the file cognite_sdk-1.0.0a26-py3-none-any.whl.

File metadata

  • Download URL: cognite_sdk-1.0.0a26-py3-none-any.whl
  • Upload date:
  • Size: 72.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.2

File hashes

Hashes for cognite_sdk-1.0.0a26-py3-none-any.whl
Algorithm Hash digest
SHA256 009f815e8c70aa2feb2b8c8753006655fe84b54bef8dc3725d55717a2b4f475c
MD5 fef251046b7fbcc10e080a56ff2931ba
BLAKE2b-256 e2aa3f89bc481c523b651519d783bbe3eaa5ca4df7f7df235a4f4a437a1767c7

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