Utilities for easier development of extractors for CDF
Project description
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.
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 uv to manage dependencies and to administrate virtual environments. To develop
extractor-utils, follow the following steps to set up your local environment:
-
Install uv 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:
$ uv sync
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.
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file cognite_extractor_utils-7.12.2.tar.gz.
File metadata
- Download URL: cognite_extractor_utils-7.12.2.tar.gz
- Upload date:
- Size: 92.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.11 {"installer":{"name":"uv","version":"0.11.11","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4d3ff11cd0851e0b39cf6b3de3015bfd2ad62278e1f9ef34611e57e879254ea7
|
|
| MD5 |
79614491bce99fba1682605032258e7a
|
|
| BLAKE2b-256 |
ac55357a786040f375e69420a160ad1d1fe263884bbbe58f79693a9353522ae4
|
File details
Details for the file cognite_extractor_utils-7.12.2-py3-none-any.whl.
File metadata
- Download URL: cognite_extractor_utils-7.12.2-py3-none-any.whl
- Upload date:
- Size: 125.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.11 {"installer":{"name":"uv","version":"0.11.11","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d846ce37fb72d7793ac432886e64fa54ab8dc6a69485723417617e2fede122d1
|
|
| MD5 |
f7f421d0444ce5f7691ee3bb20119873
|
|
| BLAKE2b-256 |
fd420f70af24601b420270944f4a3b2ea2a684fd7ad29cfff45e8e094288f95d
|
