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).
Documentation
Prerequisites
In order to start using the Python SDK, you need
- Python3 (>= 3.5) and pip
- An API key. Never include the API key directly in the code or upload the key to github. Instead, set the API key as an environment variable. See the usage example for how to authenticate with the API key.
This is how you set the API key as an environment variable on Mac OS and Linux:
$ export COGNITE_API_KEY=<your API key>
On Windows, you can follows these instructions to set the API key as an environment variable.
Installation
To install this package:
$ pip install cognite-sdk
To install this package without the pandas and NumPy support:
$ pip install cognite-sdk-core
To install with pandas, geopandas and shapely support (equivalent to installing cognite-sdk).
However, this gives you the option to only have pandas (and NumPy) support without geopandas.
$ pip install cognite-sdk-core[pandas, geo]
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
Examples
For a collection of scripts and Jupyter Notebooks that explain how to perform various tasks in Cognite Data Fusion (CDF) using Python, see the GitHub repository here
Changelog
Wondering about upcoming or previous changes to the SDK? Take a look at the CHANGELOG.
Contributing
Want to contribute? Check out CONTRIBUTING.
Metadata
Release files for cognite-sdk-core 2.56.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| cognite-sdk-core-2.56.1.tar.gz | 143.1 kB | Without provenance | Details for cognite-sdk-core-2.56.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| cognite_sdk_core-2.56.1-py3-none-any.whl | Python 3 | none | any | Details for cognite_sdk_core-2.56.1-py3-none-any.whl |
Total release size: 329.8 kB
Release files / cognite-sdk-core-2.56.1.tar.gz
| Download URL | cognite-sdk-core-2.56.1.tar.gz |
|---|---|
| Size | 143.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b0b41e3e0ebe069b5b08cd7101223592f5f7ba8fd841218c43f3a12306bc19d5
|
|
BLAKE2b-256 checksum How to use checksums |
719553720d55afeee98d1a3dfb0bdecf38b20d293c76cf0fb09069c7f4e1a768
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.8.12
|
Release files / cognite_sdk_core-2.56.1-py3-none-any.whl
| Download URL | cognite_sdk_core-2.56.1-py3-none-any.whl |
|---|---|
| Size | 186.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c5f61ee7ee87a3924fb732542f46ac0cab72963a32f6552e10ef9714b44f8dcf
|
|
BLAKE2b-256 checksum How to use checksums |
6cdc4791310c28acb7bfe39ac65d273156c98621c3850a153f96407e6f9466cb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.8.12
|
Security for cognite-sdk-core 2.56.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.