A CLI for the Transformations service in CDF
Project description
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
--user
if 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__.py
andpyproject.toml
. Make sure to update theCHANGELOG
.
This project adheres to the Contributor Covenant v2.0 as a code of conduct.
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
Built Distribution
File details
Details for the file cognite_transformations_cli-2.3.11.tar.gz
.
File metadata
- Download URL: cognite_transformations_cli-2.3.11.tar.gz
- Upload date:
- Size: 23.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.8.18
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9da6284822705c13b645a51233741d91c9dafdbbd5438753997f619ed38e7c1f |
|
MD5 | 99966b6cd3f4d69ce2c7ae8a294a0892 |
|
BLAKE2b-256 | 1f33df1b610114098595bbff2db7828166c9531f17394f7d8414a92ff9016eae |
Provenance
File details
Details for the file cognite_transformations_cli-2.3.11-py3-none-any.whl
.
File metadata
- Download URL: cognite_transformations_cli-2.3.11-py3-none-any.whl
- Upload date:
- Size: 29.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.8.18
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 82d59651d7e3291ea2982c848ec84471222b69208d30116f00c14e633eea8b8a |
|
MD5 | db3f6d4ebb6022fad27b7f12617dec4a |
|
BLAKE2b-256 | cacab1b3b562ccdbb42d19aa2bf4e2735f82aebeaf8442c10af686d16bc10b49 |