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).

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, specify them like this with pip:

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

or like this if you are using poetry:

$ poetry add cognite-sdk -E pandas -E 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

On Windows, it is recommended to install geopandas and its dependencies using conda package manager, see geopandas installation page. The following commands create a new environment, install geopandas and cognite-sdk.

conda create -n geo_env
conda activate geo_env
conda install --channel conda-forge geopandas
pip install cognite-sdk

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

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-7.76.0.tar.gz (504.6 kB view details)

Uploaded Source

Built Distribution

cognite_sdk-7.76.0-py3-none-any.whl (627.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for cognite_sdk-7.76.0.tar.gz
Algorithm Hash digest
SHA256 6bd3e1fd0002e5d0e089477c009ed356af9111f55cbff05ee08007ccb3fc2e8d
MD5 86c4e552bb7a4cfcea8ffa2f31fc660d
BLAKE2b-256 77c13ca9fc836ce58c74457a7914a47431f7abb0d63fb4c927fbf483f00365de

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for cognite_sdk-7.76.0-py3-none-any.whl
Algorithm Hash digest
SHA256 351d43fca8d6a2ed8680686748503fa4064da2585f97e445221fd35d0d182000
MD5 1a6904d0b942d6067a304ba94914adb0
BLAKE2b-256 b64e591e9c9107719e45154b73dcbf7b60d13704dda81aa376d08b99460807a6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page