Welcome to PowerOps SDK
What is it?
The PowerOps SDK is a domain-specific SDK for interacting with Cognite Data Fusion (CDF) for the power operations' domain. Requires PowerOps to be deployed and configured for CDF project before using, see project setup instructions for more details.
This SDK is used as a submodule in the power-ops-toolkit repository (private). All toolkit configuration and toolkit deployment workflows are maintained in that repo.
Main Features
cognite.powerops.client.PowerOpsClientused to interact with CDF in a domain-specific language.- Resource Sync,
resync, used to sync configuration files with CDF through the CLI toolpowerops.
Installation
pip install cognite-power-ops
Configuration
Configuration of the PowerOpsClient and resync is done through a yaml file and environment variables.
YAML configuration
The configuration is in .yaml format and the path to the configuration file must be explicitly provided. Refer to the example config file for the most up to date example of required fields.
Secrets should not be written directly in this configuration file as the file is intended to be committed to git. Instead use the following syntax to refer to an environment variable as a value.
project: "${PROJECT}"
base_url: "https://${CLUSTER}.cognitedata.com"
If you are using a .env file etc. then you must handle loading the proper environment variables prior to instantiating PowerOpsClient or running resync.
Usage
Run Resync
Refer to the resync documentation.
PowerOpsClient
Using YAML configuration:
from dotenv import load_dotenv
from cognite.powerops.client import PowerOpsClient
load_dotenv()
power_ops_client = PowerOpsClient.from_config("power_ops_config.yaml")
Using an existing CogniteClient:
from cognite.powerops.client import PowerOpsClient
# Refer to the Cognite SDK documentation for the different ways to instantiate a CogniteClient
cognite_config = {} # dict with configuration
cognite_client = CogniteClient.load(cognite_config)
# Instantiate PowerOpsClient with existing CogniteClient
power_ops_client = PowerOpsClient(client=cognite_client, read_dataset="xid_dataset", write_dataset="xid_dataset")
For more examples on using the PowerOpsClient, see the examples section of the documentation.
Running Tests
Run the test suite with:
pytest
Most tests run against an in-memory mock of PowerOpsClient (tests/mock_powerops.py) and don't require CDF access. Tests that do need a real CDF connection are marked with @pytest.mark.cdf.
To skip the CDF-dependent tests, e.g. when running locally without CDF credentials configured, use the --skipcdf flag. This is also what CI uses:
pytest --skipcdf
1 maintainer
Metadata
1 maintainer
Release files for cognite-power-ops 1.2.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_power_ops-1.2.0.tar.gz | 310.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| cognite_power_ops-1.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 931.1 kB
Release files / cognite_power_ops-1.2.0.tar.gz
| Download URL | cognite_power_ops-1.2.0.tar.gz |
|---|---|
| Size | 310.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
bf94c217145fb6fd204fd32efa21fad630bb0fa15ad53ee95def917edac8e981
|
|
BLAKE2b-256 checksum How to use checksums |
848b63e0271bd6e0d4baa3d571b2fe44070c9cfc1443414f48aea78c0889f927
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.10.21
|
Release files / cognite_power_ops-1.2.0-py3-none-any.whl
| Download URL | cognite_power_ops-1.2.0-py3-none-any.whl |
|---|---|
| Size | 621.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1acdcdbc19cb4a2fa2bcbde5f9f6f938b69e2844895c3c0231f08394f0995ce9
|
|
BLAKE2b-256 checksum How to use checksums |
e612acc15d0415d3d1780e8747df501384ce68f3ffd298557921d0469a3fe3f9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.10.21
|
