Cognite Python extractor-utils
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:
-
Install poetry if you haven't already.
-
Clone repository:
$ git clone git@github.com:cognitedata/python-extractor-utils.git -
Move into the newly created local repository:
$ cd python-extractor-utils -
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.
1 maintainer
Metadata
1 maintainer
Release files for cognite-extractor-utils 3.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| cognite-extractor-utils-3.0.0.tar.gz | 40.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| cognite_extractor_utils-3.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 90.5 kB
Release files / cognite-extractor-utils-3.0.0.tar.gz
| Download URL | cognite-extractor-utils-3.0.0.tar.gz |
|---|---|
| Size | 40.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
621fc384a57fa5d6bb3c4143a9ab9533459a8e9017eef66a9af44c678260789c
|
|
BLAKE2b-256 checksum How to use checksums |
3f86d508ce11d1d76ddff3d64438334cd95223cbd45033e2e75551507108d5bd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.8.0 pkginfo/1.8.3 readme-renderer/37.2 requests/2.28.1 requests-toolbelt/0.10.0 urllib3/1.26.12 tqdm/4.64.1 importlib-metadata/5.0.0 keyring/23.9.3 rfc3986/2.0.0 colorama/0.4.5 CPython/3.8.14
|
Release files / cognite_extractor_utils-3.0.0-py3-none-any.whl
| Download URL | cognite_extractor_utils-3.0.0-py3-none-any.whl |
|---|---|
| Size | 49.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a5d044f50c9fcb33d19d02580259604eb66f16f9d4bfce4ad09d8efad0d92ddc
|
|
BLAKE2b-256 checksum How to use checksums |
861e5b57a3b7908fbf70d5ec90df63a67896c1eb3a7349816073162e688f1167
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.8.0 pkginfo/1.8.3 readme-renderer/37.2 requests/2.28.1 requests-toolbelt/0.10.0 urllib3/1.26.12 tqdm/4.64.1 importlib-metadata/5.0.0 keyring/23.9.3 rfc3986/2.0.0 colorama/0.4.5 CPython/3.8.14
|
