Utilities for easier development of extractors for CDF
extractor-utils package is an extension of the Cognite Python SDK intended to simplify the development of data
extractors or other integrations for Cognite Data Fusion.
The changelog is found here.
The best way to start a new extractor project is to use the
cogex CLI. You can install that from PyPI:
pip install cognite-extractor-manager
To initialize a new extractor project, run
in the directory you want your extractor project in. The
cogex CLI will prompt you for some information about your
project, and then set up a poetry environment, git repository, commit hooks with type and style checks and load a
Some source systems have a lot in common, such as RESTful APIs or systems exposing as MQTT. We therefore have extensions
extractor-utils tailroed to these protocols. These can be found in separate packages:
The package is open source under the Apache 2.0 license, and contribtuions are welcome.
This project adheres to the Contributor Covenant v2.0 as a code of conduct.
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:
Install poetry if you haven't already.
$ git clone firstname.lastname@example.org:cognitedata/python-extractor-utils.git
Move into the newly created local repository:
$ cd python-extractor-utils
Create virtual environment and install dependencies:
$ poetry install
$ poetry run pre-commit install
Each public method, class and module should have docstrings. Docstrings are written in the Google style. Please include unit and/or integration tests for submitted code, and remember to update the changelog.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for cognite_extractor_utils-6.0.1.tar.gz
Hashes for cognite_extractor_utils-6.0.1-py3-none-any.whl