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

Uploaded Source

Built Distribution

cognite_extractor_utils-3.1.2-py3-none-any.whl (49.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cognite_extractor_utils-3.1.2.tar.gz
  • Upload date:
  • Size: 40.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.9.2 readme-renderer/37.3 requests/2.28.1 requests-toolbelt/0.10.1 urllib3/1.26.13 tqdm/4.64.1 importlib-metadata/5.1.0 keyring/23.11.0 rfc3986/2.0.0 colorama/0.4.6 CPython/3.8.15

File hashes

Hashes for cognite_extractor_utils-3.1.2.tar.gz
Algorithm Hash digest
SHA256 21029bd6c2814cb8a4597e6ba7904e0c74ad2b4a15fd31f09176bb6f2d570d18
MD5 f40ac1d6f2da7a5d8c4bca91ffe7b2e1
BLAKE2b-256 34e0cc1ec2128c62f5083affd85c91337e125f478cbb27b8f3cb3df34653b830

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cognite_extractor_utils-3.1.2-py3-none-any.whl
  • Upload date:
  • Size: 49.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.9.2 readme-renderer/37.3 requests/2.28.1 requests-toolbelt/0.10.1 urllib3/1.26.13 tqdm/4.64.1 importlib-metadata/5.1.0 keyring/23.11.0 rfc3986/2.0.0 colorama/0.4.6 CPython/3.8.15

File hashes

Hashes for cognite_extractor_utils-3.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 cb63c287d7e9ccc9e6eb40b2e0682c93a68bb3dad459d2f49495a0f1832ac8de
MD5 6e1423cfd026253f4a86e6dc943bf118
BLAKE2b-256 71170d51c4823a153bbd9d356b3972a333dfc8462e7a19a73580f5b59429555b

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