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.

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 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-1.6.0.tar.gz (20.0 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file cognite-transformations-cli-1.6.0.tar.gz.

File metadata

  • Download URL: cognite-transformations-cli-1.6.0.tar.gz
  • Upload date:
  • Size: 20.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.7.13

File hashes

Hashes for cognite-transformations-cli-1.6.0.tar.gz
Algorithm Hash digest
SHA256 e09ca9055827f22b94dc7ccb4f89e51a70047ded6f1260d57901ba4c6c387d32
MD5 9c8556b6b63237f00661e58b1d04e3cf
BLAKE2b-256 d575489436df98cc836a852bcb6430a52eb4dd7f4e0bb9fcf39f8abd21f87b0f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cognite_transformations_cli-1.6.0-py3-none-any.whl
  • Upload date:
  • Size: 26.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.7.13

File hashes

Hashes for cognite_transformations_cli-1.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5fce73332b94e01950041d6dc430cd4ee36da00c897bb3975241cd5e001f2935
MD5 483c220d000c810d07cf4a31b2e8cd77
BLAKE2b-256 c0bb4b7c49c79573c1454645f3109cc791e6a7c8eef297fc743588a6fd1d0e61

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