Skip to main content

Cognite Python SDK Generator

Project description

Cognite Python SDK Generator

release Documentation Status Github PyPI Downloads GitHub Code style: black Ruff mypy

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.

Alpha Note This package, pygen, is currently in alpha, which is reflected in the version number 0.x.x. This means that the package might have changes that are not backwards compatible between minor versions. It will continue to be developed towards beta and general availability (GA). You are encouraged to try it out and give feedback, but it should not be used in production until it reaches GA.

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 and 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]

If using zsh:

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 generate --space movies \
    --external-id Movie \
    --version 1 \
    --tenant-id <tenant-id> \
    --client-id <client-id> \
    --client-secret <client-secret> \
    --cdf-cluster <cdf-cluster> \
    --cdf-project <cdf-project>

If you are not using Microsoft Entra ID (Azure AD) you need to specify the parameter --token-url, --scopes and --audience instead of --tenant-id.

Dependencies

Dependencies for the generated SDK

  • cognite-sdk This is the basis for all requests to the Cognite Data Fusion API.
  • pydantic This is used for all data classes in the generated SDK.
  • pandas This is used for .to_pandas() methods in 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 (Optional) This is used for the CLI of the pygen package.
  • black (Optional) This is used to format the code generated by 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.33.0.tar.gz (67.3 kB view details)

Uploaded Source

Built Distribution

cognite_pygen-0.33.0-py3-none-any.whl (86.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for cognite_pygen-0.33.0.tar.gz
Algorithm Hash digest
SHA256 80c9506e9cb87f522edabf047250c95c78815904d02127e52febee2260745eea
MD5 dbc423f0d8cc06c626200b6027b05ebf
BLAKE2b-256 ea9ad22ffead9bf22f00fbd1f7ad29081f364b6c60aa49f10a1e8d10f9fbace2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cognite_pygen-0.33.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4d2fd5ed8e7424a9055967a85c191fa8ae4991f351c710a72ebff2ae96990b04
MD5 98beacd2822deecb17ca5be12868bbc1
BLAKE2b-256 43e91d2d79e854f227b54465df016b0e92627fb5b6b0e4933d33e4a95098f504

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