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.0a33.tar.gz (53.9 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.0a33-py3-none-any.whl (74.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for cognite-sdk-1.0.0a33.tar.gz
Algorithm Hash digest
SHA256 c1257f7beed169507c89dd025810a6e2a94d576d9f7508045727da35c084adc3
MD5 dbb293458ab4d06c68d3cc3cf27b4482
BLAKE2b-256 4773786d752c7ef6c3233e4ef7f574ce39810d3cd3b1226e9293fad185c231ff

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for cognite_sdk-1.0.0a33-py3-none-any.whl
Algorithm Hash digest
SHA256 a4bc36ceecec7c45d6e0a6cd28dc121a3830539b5b26899be9027a2948933e92
MD5 724f84146abc90995a9bc4b3f50031e1
BLAKE2b-256 9c62d220dc46a6fa8538efa6692a4230d375c8b547173240283a4cd87e35d826

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