Skip to main content

Cognite Python SDK Generator

Project description

Cognite Python SDK Generator

build GitHub Code style: black

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

  • cli This 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.

image

image

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 pygen package.

Changelog

Wondering about previous changes to the SDK? Take a look at the CHANGELOG.

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_pygen-0.10.6.tar.gz (21.0 kB view details)

Uploaded Source

Built Distribution

cognite_pygen-0.10.6-py3-none-any.whl (25.8 kB view details)

Uploaded Python 3

File details

Details for the file cognite_pygen-0.10.6.tar.gz.

File metadata

  • Download URL: cognite_pygen-0.10.6.tar.gz
  • Upload date:
  • Size: 21.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.17

File hashes

Hashes for cognite_pygen-0.10.6.tar.gz
Algorithm Hash digest
SHA256 5694ce5ec7750d58adb17cf6ccaa280626efda316daeaa5cdfcf3bb76ff78453
MD5 308da8a90352dd750b27c8d3de11960a
BLAKE2b-256 5aefc50b26b806c2ae16ccbb435c5c8e1c6d8bf7641ba717fa43ae9dffd503e0

See more details on using hashes here.

File details

Details for the file cognite_pygen-0.10.6-py3-none-any.whl.

File metadata

File hashes

Hashes for cognite_pygen-0.10.6-py3-none-any.whl
Algorithm Hash digest
SHA256 6aedbb5749567bc2838c39fd01a11b0ddb4bfbac3fd0944739ae57f839a60914
MD5 bc2a2c6dd75a1f4981230fddc9347ef5
BLAKE2b-256 4d6738b8519e8fe00b3a4320f3325df60e543109905a6030d8308a620ed9d895

See more details on using hashes here.

Supported by

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