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

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

Uploaded Source

Built Distribution

cognite_extractor_utils-7.5.4-py3-none-any.whl (90.8 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for cognite_extractor_utils-7.5.4.tar.gz
Algorithm Hash digest
SHA256 66bb8d6571fcb5cb4b359b38f8a2a404a4e4890a15a9fc29809dc7dd10a33de9
MD5 56f4e9478c51a32a50606ebf27602aea
BLAKE2b-256 c66021da57673d15987e3d33f5416ca397eadda511327bac53d0019a712d7897

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cognite_extractor_utils-7.5.4-py3-none-any.whl
Algorithm Hash digest
SHA256 9aa8aa0d3a767d6793a9695ff732054e7e01ee9f9130125a5e4c090f2a0effbc
MD5 53ca073cab463e4617607196172c646a
BLAKE2b-256 0cd6fe468e9825300853135fc935d6a8e1c3883c98c805a9323a11ba0420d68e

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