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

Uploaded Source

Built Distribution

cognite_sdk-7.75.2-py3-none-any.whl (627.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cognite_sdk-7.75.2.tar.gz
  • Upload date:
  • Size: 504.3 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.75.2.tar.gz
Algorithm Hash digest
SHA256 c476c6cf5336012f4561a8883b4674889675dbb7f67e83245d20590d9f4f55ca
MD5 7c069fe1fb0bc44ca17bc9761f364915
BLAKE2b-256 d7b959977624d0e8de3f4a6f041d837115d18bab60fc6281c0f08a5f90f926ba

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cognite_sdk-7.75.2-py3-none-any.whl
  • Upload date:
  • Size: 627.4 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.75.2-py3-none-any.whl
Algorithm Hash digest
SHA256 0118f55d2ded9d10e2bf7102c98e95ab8677db9dca007674be668a38513cf12f
MD5 a446cf5cb133b3b8550e2256ef8d287b
BLAKE2b-256 63def2ce2042d8af65265491e0a9361754d7b069ddf03bf1c5bcb36d3534fa74

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