cognite-transformations-cli 1.2.0

A CLI for the Transformations service in CDF

Cognite Python transformations-cli

Transformations CLI

The Transormations CLI is a replacement for jetfire-cli rewritten on top of the new Python SDK for Transformations.

CLI Documentation

Documentation for CLI is hosted here.

GitHub Action

transformations-cli also provides a GitHub Action which can be used to deploy transformations. You can find the documentation for transformations-cli GitHub Action here.

GitHub Action Migration: jetfire-cli@v2 to transformations-cli@main

If you've already used the old jetfire-cli in a GitHub Action we recommend you migrate to the new GitHub Action. You can find the migration guide here.

Contributing

We use poetry to manage dependencies and to administrate virtual environments. To develop transformations-cli, follow the following steps to set up your local environment:

1. Install poetry: (add --user if desirable)

   $ pip install poetry
   

2. Clone repository:

   $ git clone [e-mail]:cognitedata/transformations-cli.git
   

3. Move into the newly created local repository:

   $ cd transformations-cli
   

4. Create virtual environment and install dependencies:

   $ poetry install
   

All code must pass black and isort style checks to be merged. It is recommended to install pre-commit hooks to ensure this locally before commiting code:

$ poetry run pre-commit install

To publish a new version change the version in cognite/transformations_cli/__init__.py and pyproject.toml. Also, remember to add an entry to CHANGELOG.

This project adheres to the Contributor Covenant v2.0 as a code of conduct.