Cognite Python SDK
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.
2 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file cognite_sdk-7.94.2.tar.gz.
File metadata
- Download URL: cognite_sdk-7.94.2.tar.gz
- Upload date:
- Size: 541.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
75800ff108e0de96d254ded95833f096ec0ce2bcfe042508e2507ad35510723b
|
|
| MD5 |
4cb460fa12ca874e81c6b71cb2a5c10a
|
|
| BLAKE2b-256 |
02cd94b01f9a1b4df613c34b93e787292eeb8c6c636461248fae6ea901486d9a
|
File details
Details for the file cognite_sdk-7.94.2-py3-none-any.whl.
File metadata
- Download URL: cognite_sdk-7.94.2-py3-none-any.whl
- Upload date:
- Size: 688.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0a590ada20bb665cb4fa733806b99cbb8e44263f42a11c08c5c7ba351fe644cf
|
|
| MD5 |
fdf434e7f255a40de04ec33465bd6e5d
|
|
| BLAKE2b-256 |
0612571dda1a282de973c234abe3067872ab402cc16bc70a43a06ee55655ef48
|
