Skip to main content

Cognite Python SDK

Project description

Cognite logo

Cognite Python SDK

build Downloads GitHub codecov Documentation Status PyPI version conda version mypy 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).

What's new in v8

The SDK v8 introduces full async support with the new AsyncCogniteClient. This enables:

  • Native async/await patterns for all API operations
  • Non-blocking concurrent operations directly in Notebooks (including browser-based via Pyodide) and UI frameworks like Streamlit
  • Significantly faster file uploads on Windows (new underlying HTTP client, httpx)
# Async client (new in v8!)
from cognite.client import AsyncCogniteClient

async def main():
    client = AsyncCogniteClient()
    tss = await client.time_series.list()

# Sync client (still supported)
from cognite.client import CogniteClient

client = CogniteClient()
tss = client.time_series.list()

The synchronous CogniteClient remains fully supported and now wraps the async client internally. See the Migration Guide for a complete list of changes.

Reference documentation

Installation

Without any optional dependencies

To install the core version of this package:

pip install cognite-sdk

With optional dependencies

A number of optional dependencies may be specified in order to support a wider set of features. The available extras (along with the libraries they include) are:

  • numpy [numpy]
  • pandas [pandas]
  • geo [geopandas, shapely]
  • sympy [sympy]
  • yaml [PyYAML]
  • all [numpy, pandas, geopandas, shapely, sympy, PyYAML]

To include optional dependencies:

pip:

pip install "cognite-sdk[pandas, geo]"

poetry:

poetry add cognite-sdk -E pandas -E geo

uv:

uv add "cognite-sdk[pandas, geo]"

Performance notes

If you regularly need to fetch large amounts of datapoints, consider installing with numpy (or with pandas, as it depends on numpy) for best performance, then use the retrieve_arrays (or retrieve_dataframe) endpoint(s). This avoids building large pure Python data structures, and instead reads data directly into memory-efficient numpy.ndarrays.

Windows specific

If you experience issues installing the geo extra on Windows, consider using conda to install geopandas first. See the geopandas installation page for details.

Changelog

Wondering about upcoming or previous changes to the SDK? Take a look at the CHANGELOG.

Migration Guide

To help you upgrade your code(base) quickly and safely to a newer major version of the SDK, check out our migration guide. It is a more focused guide based on the detailed change log. MIGRATION GUIDE.

Contributing

Want to contribute? Check out CONTRIBUTING.

Project details


Release history Release notifications | RSS feed

This version

8.8.0

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-8.8.0.tar.gz (722.8 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-8.8.0-py3-none-any.whl (956.1 kB view details)

Uploaded Python 3

File details

Details for the file cognite_sdk-8.8.0.tar.gz.

File metadata

  • Download URL: cognite_sdk-8.8.0.tar.gz
  • Upload date:
  • Size: 722.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.20

File hashes

Hashes for cognite_sdk-8.8.0.tar.gz
Algorithm Hash digest
SHA256 a7247c21c8fc61b7a0a17139f421ba43b452653398a9d212b03578c08d824055
MD5 a103c4ec8acfa6901014a333b5ae1bcb
BLAKE2b-256 5c459038d8e411a44b3eaaa831b2c4f87a472d6ea7eca992513ea76ea51eafcc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cognite_sdk-8.8.0-py3-none-any.whl
  • Upload date:
  • Size: 956.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.20

File hashes

Hashes for cognite_sdk-8.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 89f15a68345e63390ba41b1a83b98ec12e0fe606e39bfd83a9a9f5a6626afc0d
MD5 7916cc7de8ff135872fb6a02643ad490
BLAKE2b-256 78681ebb8a6241eec6b1e901167d6a9ec5171cc2bd471c5e32446b10bf75f0ec

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