Skip to content

cognitedata/cognite-python-utils

Repository files navigation

Cognite Python Utilities

Test and Build Contributor Covenant Code Style: Black

This is a package of utilities extending the use of Cognite products. Its aim is to assist Cognite users with common/recurrent workflows and applications.

Directory Structure

├── cognite                         <- Source code
│   └── utils
│       ├── contextualization       <- Functionalities relating to contextualization
│       ├── infrastructure          <- Functionalities relating to infrastructure
│       ├── ...
│       └── __init__.py

Getting Started

To install this package, run:

$ pip install cognite-utils

Or, if using poetry, run:

$ poetry add cognite-utils

The following shows how you can load functionalities in the package:

>>> from cognite.utils.contextualization import EntityMatchCategorizer
>>> from cognite.utils.infrastructure import ProjectArchiver

Documentation

To update project documentation, follow instructions here.

Contributing

Want to contribute? Check out Development page. As an open source project, we abide by the Contributor Covenant.