Cognite Transformations CLI
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:
-
Install poetry: (add
--userif desirable)$ pip install poetry -
Clone repository:
$ git clone git@github.com:cognitedata/transformations-cli.git -
Move into the newly created local repository:
$ cd transformations-cli -
Create a virtual environment and install dependencies:
$ poetry install -
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
- To run tests:
$ poetry run pytest
$ poetry run pytest <test file path>
$ poetry run pytest <test file path>::<test function name>
- To publish a new version, change the version in
cognite/transformations_cli/__init__.pyandpyproject.toml. Make sure to update theCHANGELOG.
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)
| File | Size | Uploaded | |
|---|---|---|---|
| cognite_transformations_cli-2.3.12.tar.gz | 23.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| 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
|