/python-extractor-utils

Common utilities for developing extractors in Python

Primary LanguagePythonApache License 2.0Apache-2.0

Cognite logo

Cognite Python extractor-utils

Build Status Documentation Status codecov PyPI version PyPI - Python Version License Code style: black

A package containing convenient utilities for developing extractors in Python.

Documentation is hosted here.

Contributing

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: (add --user if desirable) 
    $ pip install poetry
  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

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

This project adheres to the Contributor Covenant v2.0 as a code of conduct.