Skip to main content
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.

Metadata

Release files for cognite-extractor-utils 7.5.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for cognite-extractor-utils 7.5.3
File Size Uploaded Provenance Actions
cognite_extractor_utils-7.5.3.tar.gz 64.7 kB Without provenance Details for cognite_extractor_utils-7.5.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for cognite-extractor-utils 7.5.3
File Interpreter ABI Platform Actions
cognite_extractor_utils-7.5.3-py3-none-any.whl Python 3 none any Details for cognite_extractor_utils-7.5.3-py3-none-any.whl

Total release size: 155.4 kB

Release files / cognite_extractor_utils-7.5.3.tar.gz

Download URL cognite_extractor_utils-7.5.3.tar.gz
Size 64.7 kB
Tags Source
SHA-256 checksum
How to use checksums
bfecb8ae2c2c0a158849a7f62880ff2bae4080876cad0d802bb9b77ec6c5e1cd
BLAKE2b-256 checksum
How to use checksums
b795e06f00f84b3501dced94626893b996c16b8fbc9174115d76d30b688b8aff
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.10.15

Release files / cognite_extractor_utils-7.5.3-py3-none-any.whl

Download URL cognite_extractor_utils-7.5.3-py3-none-any.whl
Size 90.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f3ea68f5d2dfe2b6c68648699c77bfabdcd877304566a3094d83810659edbba4
BLAKE2b-256 checksum
How to use checksums
a28f4e2ae91bb7224c08449d19b851d875ab52fb9a846d0f84f15f0adb8d7fa4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.10.15

Security for cognite-extractor-utils 7.5.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

7.5.3 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page