Skip to content

v1.0.0 - A New Era

Compare
Choose a tag to compare
@berkorbay berkorbay released this 23 Dec 16:16
· 7 commits to main since this release

Finally, after more than a year, we have the v1.0.0. Though v1.0.0 is not an end, but a beginning. We had the complete call coverage at v0.7.3. With v1.0.0+, eptr2 will provide opportunities to actually use Transparency in your reports and dashboards. Therefore v1.0.0 is not an end but a beginning.

We have two major developments.

Tutorial Interfaces

We used to refer people to eptr2demo to figure out which calls to make and how to configure them. Now you can call it inside the package.

from eptr2.tutorials import run_demo_app
run_demo_app(username="YOUR_USERNAME",password="YOUR_PASSWORD")

Tutorial interfaces are currently experimental and they may include breaking changes.

Composite Functions

Each call in eptr2 gets a different data set. But sometimes we need several sets of data together to have the full picture of a time period. We bring in composite functions in this version.

We start with an example. Consumption data is important for many analysts. There is real time consumption, settlement consumption (UECM) and load plan (forecasted consumption). Our first composite function get_hourly_consumption_and_forecast_data brings all three data sources together.

from eptr2 import EPTR2
from eptr2.composite import get_hourly_consumption_and_forecast_data

eptr = EPTR2(username="YOUR_USERNAME",password="YOUR_PASSWORD")
df = get_hourly_consumption_and_forecast_data(eptr, start_date="2024-07-29", end_date="2024-07-29")
print(df)

If you have good ideas about composite functions, please write to us.

Composite functions are currently experimental and they may include breaking changes.

Other changes

We are improving the eptr2 experience continuously. Now, it is possible to register username and password from a file or through environment variables. A credentials json file shall look like this one.

{
    "EPTR_USERNAME": "YOUR_TRANSPARENCY_USER_EMAIL",
    "EPTR_PASSWORD": "YOUR_TRANSPARENCY_PASSWORD"
}

Just add the extra parameter (credentials_file_path) and json file path to the EPTR2 object.

Alternatively you can define environment variables "EPTR_USERNAME" and "EPTR_PASSWORD" and EPTR2 object will take care of those as credentials as well.