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]
  • functions [pip]
  • yaml [PyYAML]
  • all [numpy, pandas, geopandas, shapely, sympy, pip, 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.3.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.3.0.tar.gz (703.5 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.3.0-py3-none-any.whl (934.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for cognite_sdk-8.3.0.tar.gz
Algorithm Hash digest
SHA256 7e13b4dc7d646effa2a82c469998275a4277fa907ed21f3b42e65165fe5dbccc
MD5 2e8bca36cb15284c2359bce2006c540b
BLAKE2b-256 1e9196639138303ceaf811aad5233b3741e33f75e096b522e02afb95e22166d1

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for cognite_sdk-8.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 64e5c2b7376744976dd6ef13a49e5231a73bdd86befa5743e17a4cdf9013fd6b
MD5 8514ec7c218b340190ab74424cb21b43
BLAKE2b-256 c332fd8500556fc34116457d29f052f89f709e1572b437703282a561771d13f9

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