Cognite Python SDK Generator
Project description
Cognite Python SDK Generator
This is the Cognite Python SDK Generator, pygen. The purpose of this package is to help developers to
work with Cognite Data Fusion's (CDF) Data Models (DM) in Python.
[DISCLAIMER!] This project is in a highly experimental state, and no guarantees are made for consistency between versions. The project may also become deprecated if the experimentation turns out to be a dead end.
The core functionality is to provide a Python client that matches a data model. This enables the developer for the following benefits
- Client side validation of the data before writing it to CDF.
- Autocompletion is matching the data model in the integrated developer environment (IDE). This is important as it enables:
- Discoverability of a data model through Python.
- Reduced typing errors in development.
- Keeping the language domain specific for the developer. Instead of working with generic concepts such as instances, nodes, edges, the developer can work with the concepts in the data model.
Documentation
See the documentation for more information.
Installation
Without any optional dependencies
To install this package without CLI support:
pip install cognite-pygen
With optional dependencies
cliThis includes CLI support such that you can run the package from the command line.
pip install cognite-pygen[cli]
Usage
The goal of the package is to have representations of all the types in a given data model with API calls to .list(), .apply(), .delete(), and .retrieve() individuals for each type.
Creating a Python SDK from a Data Model
Given a Data Model with external id Movie in the space movies in CDF, the following command will generate a Python SDK
pygen --space movies --external-id Movie --tenant-id <tenant-id> --client-id <client-id> --client-secret <client-secret> --cdf-cluster <cdf-cluster> --cdf-procect <cdf-project>
Dependencies
Dependencies for the generated SDK
- cognite-sdk This is the basis for all requests to the Cognite Data Fusion API. This is a dependency for the generated SDK.
- pytandic This is used for all data classes in the generated SDK. This is a dependency for the generated SDK.
Dependencies for the pygen
- jinja2 This is used for the templating of the generated SDK.
- inflect This is used for the singularization/pluralization of words in the generated SDK.
- typer This is used for the CLI of the
pygenpackage.
Changelog
Wondering about previous changes to the SDK? Take a look at the CHANGELOG.
Contributing
Want to contribute? Check out CONTRIBUTING.
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
Built Distribution
Hashes for cognite_pygen-0.10.4-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | facc9962bc6dae5277a079fdb6406d5e32795a60ab2f704eddb2050dc41305e9 |
|
| MD5 | eaff159e047aaeb62f4a94cb71a5ab05 |
|
| BLAKE2b-256 | 5263953aeddfc07b8bec9f4b3c611621021e9fa521a8918c6985d775e3e6345d |
