OEP Client

This tool eases data sharing with the Open Energy Platform (OEP). Common tasks on the OEP are:

creating a table
uploading data
updating a table's metadata
downloading data
retrieving a table's metadata
deleting a table (that you created)

You can also always just use the API directly if your tasks are more complex.

Notes for Windows Users

All the example commands below use python3, because we need python 3. Under Windows, it's most likely to be python.exe or just python.

Installation

Install package oep-client from python package index with pip:

python3 -m pip install --upgrade oep-client

Authentification

You need to be registered on the OEP platform and have a valid API token. You can find your token in your user profile on the OEP under Your Security Information.

Test

There is a short test script that creates a table on the platform, uploads data and metadata, downloads them again and finally deletes the table.

You can run it either directly from the command prompt using

oep-client -t OEP_API_TOKEN test

Notes on Data and Metadata

Supported filetypes that the client can work with are are: xslx, csv, json. Your metadata must be a json file that complies with the metadata specification of the OEP.

Notes on Usage

All tasks can be executed either directly as a comand line script (CLI) oep-client that comes with this package, or in a python environment.

The CLI is very handy for standardized tasks as it requires just one command line, but is somewhat limited when for instance your input data is not in a very specific format. To see avaiblabe command line options, use

oep-client --help

In a python environment, you have more flexibility to prepare / clean your data before uploading it.

Using the CLI

Creating a table

Requires a valid metadata file.

You need to specify names and data types of your columns in the metadata, which also must be valid postgres data types.

metadata.json

{
  "resources": [
    {
      "schema": {
        "fields": [
          {
            "name": "id",
            "type": "bigserial"
          },
          {
            "name": "field_1",
            "type": "varchar(32)",
            "description": "column description",
            "unit": "unit name"
          }
        ]
      }
    }
  ]
}

oep-client -t OEP_API_TOKEN create TABLE_NAME metadata.json

Uploading data

oep-client -t OEP_API_TOKEN insert TABLE_NAME FILENAME

if FILENAME is a

xlsx, you have to also specify --sheet SHEETNAME
csv, you may also specify --delimiter DELIMITER and or --encoding ENCODING

Updating a table's metadata

This of course requires a valid metadata file.

oep-client -t OEP_API_TOKEN metadata set TABLE_NAME metadata.json

Downloading data

Note: you do not need an API_TOKEN to downlad data

oep-client -t OEP_API_TOKEN select TABLE_NAME FILENAME

if FILENAME is a

xlsx, you have to also specify --sheet SHEETNAME
csv, you may also specify --delimiter DELIMITER and or --encoding ENCODING

Retrieving a table's metadata

Note: you do not need an API_TOKEN to downlad metadata.

oep-client -t OEP_API_TOKEN metadata get TABLE_NAME FILENAME

Deleting a table (that you created)

oep-client -t OEP_API_TOKEN drop TABLE_NAME

Using the Package in Python

All examples assume that you import the package and create a client instance first:

from oep_client import OepClient
cl = OepClient(token='API_TOKEN', ...)

Metadata

Release files for oep-client 0.19.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for oep-client 0.19.0
File	Size	Uploaded
oep_client-0.19.0.tar.gz	17.2 kB	Dec 23, 2025	Details

Built distribution (wheel)

Table of built distributions (wheels) for oep-client 0.19.0
File	Interpreter	ABI	Platform	Reset
oep_client-0.19.0-py3-none-any.whl 18.7 kB Dec 23, 2025	Python 3	none	any	Details

Total release size: 35.8 kB

Release files / oep_client-0.19.0.tar.gz

Download URL	oep_client-0.19.0.tar.gz
Size	17.2 kB
Tags	Source
SHA-256 checksum How to use checksums	`04459cf03058a7014ded6a7b3aac02b31143b5d543cc97ba2b65e7a12f73c947`
BLAKE2b-256 checksum How to use checksums	`10ab57afa62f12c29fb402130637c4801b04763ba1dcf906e6bb5505863e8d72`
Upload date	Dec 23, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.13.7`

Release files / oep_client-0.19.0-py3-none-any.whl

Download URL	oep_client-0.19.0-py3-none-any.whl
Size	18.7 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`7a3abe83da2d9fc92bc4d90ccc42d264d8f9cf0249da7b643b15cfc6263b0e24`
BLAKE2b-256 checksum How to use checksums	`4d564940a640874f9f6634363930a29d16844d2447032f65558874fff5e5a5ec`
Upload date	Dec 23, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.13.7`