Skip to main content

Cognite Transformations CLI

Build Status Documentation Status codecov PyPI version PyPI - Python Version License Code style: black

Transformations CLI

Use the Transformations command-line interface (Transformations CLI) to manage the lifecycle of your transformation jobs using the command line. With the Transformations CLI, you can process data from the CDF staging area (RAW) into the CDF data model. To learn more about how the Cognite Transformations CLI package works, see the documentation here

The Transformations CLI is based on Python and replaces the Jetfire CLI.

GitHub Action

The Transformations CLI provides a GitHub Action to deploy transformations. You'll find the documentation here.

We've also created a CI/CD template that uses GitHub Workflows. You'll find the documentation here.

Using Transformations CLI in Azure Pipelines

We publish transformations-cli docker images in dockerhub for every version released. The images tagged as cognite/transformations-cli:<version>-azure can be used in Azure Pipelines (See an example tag here). We suggest you check the example Azure Pipeline workflow configuration and the corresponding transformation manifest.

Migrating from Jetfire CLI

Transformations CLI replaces the Jetfire CLI. If you've already used the Jetfire CLI in a GitHub Action, we recommend migrating to the Transformations CLI GitHub Action. You'll find the migration guide here.

Contributing

We use poetry to manage dependencies and to administrate virtual environments. To develop Transformations CLI, follow these steps to set up your local environment:

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

    $ pip install poetry
    
  2. Clone repository:

    $ git clone git@github.com:cognitedata/transformations-cli.git
    
  3. Move into the newly created local repository:

    $ cd transformations-cli
    
  4. Create a virtual environment and install dependencies:

    $ poetry install
    
  5. All the code must pass black and isort style checks before it can be merged. We recommend installing pre-commit hooks to ensure this locally before you commit your code:

$ poetry run pre-commit install
  1. To run tests:
$ poetry run pytest
$ poetry run pytest <test file path>
$ poetry run pytest <test file path>::<test function name>
  1. To publish a new version, change the version in cognite/transformations_cli/__init__.py and pyproject.toml. Make sure to update the CHANGELOG.

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

Metadata

Release files for cognite-transformations-cli 2.3.12

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for cognite-transformations-cli 2.3.12
File Size Uploaded
cognite_transformations_cli-2.3.12.tar.gz 23.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for cognite-transformations-cli 2.3.12
File Interpreter ABI Platform
cognite_transformations_cli-2.3.12-py3-none-any.whl Python 3 none any Details

Total release size: 53.2 kB

Release files / cognite_transformations_cli-2.3.12.tar.gz

Download URL cognite_transformations_cli-2.3.12.tar.gz
Size 23.3 kB
Tags Source
SHA-256 checksum
How to use checksums
7b3b42414993e7e8be648cad230d037bd352ffa7a349236aabfe7ed4d8c63712
BLAKE2b-256 checksum
How to use checksums
277e0f52d9d6fbed9c9360eb6fe0c9d8b491563be7ab2c07033ddf93e65f44bb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.8.18

Release files / cognite_transformations_cli-2.3.12-py3-none-any.whl

Download URL cognite_transformations_cli-2.3.12-py3-none-any.whl
Size 30.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8714a88913852510358e7909909d63c89eb1f09d5acc68c90238c3fc703095c2
BLAKE2b-256 checksum
How to use checksums
84a252c0cded83a87dc1867cff7e28abce09bfd1fb7054a000f6b763f683413e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.8.18

Release history Release notifications | RSS feed

This release

2.3.12 This release

2 release files

2.3.11

2 release files

2.3.10

2 release files

2.3.9

2 release files

2.3.8

2 release files

2.3.7

2 release files

2.3.6

2 release files

2.3.5

2 release files

2.3.4

2 release files

2.3.3

2 release files

2.3.2

2 release files

2.3.1

2 release files

2.3.0

2 release files

2.2.2

2 release files

2.2.1

2 release files

2.2.0

2 release files

2.1.5

2 release files

2.1.4

2 release files

2.1.2

2 release files

2.1.1

2 release files

2.1.0

2 release files

2.0.0

2 release files

1.6.2

2 release files

1.6.1

2 release files

1.6.0

2 release files

1.5.1

2 release files

1.5.0

2 release files

1.4.2

2 release files

1.4.1

2 release files

1.4.0

2 release files

1.3.2

2 release files

1.3.1

2 release files

1.3.0

2 release files

1.2.11

2 release files

1.2.10

2 release files

1.2.9

2 release files

1.2.8

2 release files

1.2.7

2 release files

1.2.6

2 release files

1.2.5

2 release files

1.2.4

2 release files

1.2.3

2 release files

1.2.2

2 release files

1.2.1

2 release files

1.2.0

2 release files

1.1.0

2 release files

1.0.1

2 release files

1.0.0

2 release files

0.2.0

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page