Skip to main content

A CLI for the Transformations service in CDF

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cognite_transformations_cli-2.3.2.tar.gz (23.4 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file cognite_transformations_cli-2.3.2.tar.gz.

File metadata

  • Download URL: cognite_transformations_cli-2.3.2.tar.gz
  • Upload date:
  • Size: 23.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.9.6 readme-renderer/37.3 requests/2.28.2 requests-toolbelt/0.10.1 urllib3/1.26.15 tqdm/4.65.0 importlib-metadata/6.0.0 keyring/23.13.1 rfc3986/2.0.0 colorama/0.4.6 CPython/3.8.16

File hashes

Hashes for cognite_transformations_cli-2.3.2.tar.gz
Algorithm Hash digest
SHA256 1d5fef0ef77c825d60d27b235a196a353791bbb40e62af49964370401c32741b
MD5 40ed32e7d37dba10d81c387e5aca4672
BLAKE2b-256 134e856400475f5b2f4d4edc5ea5722eaa3e78c6e1e0b7786b23fb643de39ee0

See more details on using hashes here.

File details

Details for the file cognite_transformations_cli-2.3.2-py3-none-any.whl.

File metadata

  • Download URL: cognite_transformations_cli-2.3.2-py3-none-any.whl
  • Upload date:
  • Size: 30.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.9.6 readme-renderer/37.3 requests/2.28.2 requests-toolbelt/0.10.1 urllib3/1.26.15 tqdm/4.65.0 importlib-metadata/6.0.0 keyring/23.13.1 rfc3986/2.0.0 colorama/0.4.6 CPython/3.8.16

File hashes

Hashes for cognite_transformations_cli-2.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8459daacacfdf3f701d4e3b4d28967ffea8ca4710ae2488b8b8a899d6f0d3017
MD5 d26909fb11aa9689646018f87578a519
BLAKE2b-256 cc76dacdf61ceecdee975628a4be54b18793708bf7adb12cdfd7147b8cc636d9

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