Skip to main content

Utilities for easier development of extractors for CDF

Project description

Cognite logo

Cognite Python extractor-utils

Build Status Documentation Status codecov PyPI version PyPI - Python Version License Code style: black

The 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.

Documentation is hosted here, including a quickstart tutorial.

The changelog is found here.

Overview

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

cogex init

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 template.

Extensions

Some source systems have a lot in common, such as RESTful APIs or systems exposing as MQTT. We therefore have extensions to extractor-utils tailroed to these protocols. These can be found in separate packages:

Contributing

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.

Development environment

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 if you haven't already.

  2. Clone repository:

    $ git clone git@github.com: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
    

Code requirements

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

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.

Project details


Release history Release notifications | RSS feed

This version

6.2.1

Download files

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

Source Distribution

cognite_extractor_utils-6.2.1.tar.gz (44.6 kB view details)

Uploaded Source

Built Distribution

cognite_extractor_utils-6.2.1-py3-none-any.whl (64.1 kB view details)

Uploaded Python 3

File details

Details for the file cognite_extractor_utils-6.2.1.tar.gz.

File metadata

File hashes

Hashes for cognite_extractor_utils-6.2.1.tar.gz
Algorithm Hash digest
SHA256 e359dc1c250e823926ddb1cc811bbd81b0bcdd10d885f8741f17f67ae10f55d0
MD5 18999a69e71ce5a87ef1e4705f725b4c
BLAKE2b-256 3c3d6da4fb6733ac616bc09582e02efe8ba05586498b44a2bbe7a7918504aca1

See more details on using hashes here.

File details

Details for the file cognite_extractor_utils-6.2.1-py3-none-any.whl.

File metadata

File hashes

Hashes for cognite_extractor_utils-6.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ec1fa458009a9187c21b1e6f891d2a96f970fba872741547b6a23859dc3ab0e8
MD5 9abbe84de3927fd9ec480005e2b38ddb
BLAKE2b-256 73b96eeb578f56f361e5efd583c89ddb62229ccf21b3b4f06a6be861adf1fb0a

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