eptr2 0.2.0

EPIAS Transparency Platform v2.0 Python client by Robokami Data

EPIAS Transparency Platform v2.0 Python client by Robokami Data

[!IMPORTANT] Try eptr2 online now! Use eptr2demo app for a limited set of calls (for now). Valid for eptr2 version 0.1.7 and later.

🇹🇷 Türkçe açıklama için aşağıya bakınız.

eptr2 (EPIAS Transparency 2.0) package is a thin wrapper around EPIAS Transparency Platform v2.0 API brought to you by Robokami. It is an unofficial package with Apache License 2.0 (free and permissable use for commercial applications, see details).

[!IMPORTANT]
EPIAS Transparency Platform v2.0 went live on Dec. 4, 2023.

[!IMPORTANT]
eptr2 is still in active development. Breaking changes can be expected. Fill an issue if you encounter any problem.

eptr2 currently covers 95 services with convenience methods. You can also use transparency_call function to call any service with any method and body.

Installation

You can simply use PyPI to install eptr2 package.

pip install eptr2

or directly through GitHub.

pip install git+https://github.com/Tideseed/eptr2.git

Usage

There are two types of calls. For instance, let's try to get MCP (PTF) of 2023-10-10.

• First type is limited with a number of services, but with a better interface.

from eptr2 import EPTR2

eptr = EPTR2()

mcp = eptr.mcp(start_date="2023-10-10T00:00:00+03:00",end_date="2023-10-10T00:00:00+03:00")
print(mcp.json())

## or directly with the call function
mcp_call = eptr.call("mcp",start_date="2023-10-10T00:00:00+03:00",end_date="2023-10-10T00:00:00+03:00")
print(mcp.json())

## from v0.1.1 you can use date strings instead of datetime objects
mcp = eptr.mcp(start_date="2023-10-10",end_date="2023-10-10")
print(mcp.json())

## from v0.1.2 you can use date strings in call method instead of datetime objects
mcp = eptr.call("mcp",start_date="2023-10-10",end_date="2023-10-10")
print(mcp.json())

You can search for available calls with eptr.services attribute. We plan to include all transparency services in the future.

available_calls = eptr.get_available_calls()
print(available_calls)

• Second type is more flexible, but you need to know the API endpoints and parameters.

from eptr2 import transparency_call

mcp = transparency_call(
    call_path="electricity-service/v1/markets/dam/data/mcp",
    call_method="POST",
    call_body={"startDate":"2023-10-10T00:00:00+03:00","endDate":"2023-10-10T00:00:00+03:00"}
    )

print(mcp.json())

[!IMPORTANT]
API requests are currently without local SSL certificate verification (verify=False) by default, because of repeated errors encountered due to OpenSSL 3.0 and local system certificate issues. We are aware that this is not a good safety practice. This issue is expected to be fixed soon. Meanwhile, you can simply add verify_with_local_ssl=True to your call to enable local SSL certificate verification.

EPİAŞ Şeffaflık Platformu 2.0 Python kütüphanesi (Robokami Data)

eptr2 (EPİAŞ Transparency 2.0) paketi Robokami tarafından EPİAŞ Şeffaflık Platformu 2.0 API'si üzerine geliştirilmiş bir Python paketidir. Apache License 2.0 ile lisanslanmıştır (ücretsiz ve büyük ölçüde serbest kullanım).

Yukarıdaki yükleme ve kullanım talimatları ile hızlıca başlayabilirsiniz.

[!IMPORTANT]
EPİAŞ Şeffaflık Platformu v2.0 hala simülasyon modunda çalışmaktadır ve 4 Aralık 2023 tarihinde canlıya alınacaktır. Çeşitli değişiklikler beklenebilir. En azından kök adreste değişiklik beklenmektedir (https://seffaflik.epias.com.tr -> https://seffaflik.epias.com.tr).

[!IMPORTANT]
eptr2 hala aktif olarak geliştirilmektedir. Büyük değişiklikler beklenebilir. Herhangi bir sorunda, issue kısmından istek açabilirsiniz.