cognite-extractor-utils 2.1.1

Utilities for easier development of extractors for CDF

Cognite Python extractor-utils

A package containing convenient utilities for developing extractors in Python.

Documentation is hosted here.

The changelog is found here

Contributing

We use poetry to manage dependencies and to administrate virtual environments. To develop extractor-utils, follow the following steps to set up your local environment:

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

   $ pip install poetry
   

2. Clone repository:

   $ git clone [e-mail]:cognitedata/python-extractor-utils.git
   

3. Move into the newly created local repository:

   $ cd python-extractor-utils
   

4. Create virtual environment and install dependencies:

   $ poetry install
   

All code must pass black and isort style checks to be merged. It is recommended to install pre-commit hooks to ensure this locally before commiting code:

$ poetry run pre-commit install

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

Each public method, class and module should have docstrings. Docstrings are written in the Google style