gie package

Subpackages

Submodules

gie.exceptions module

A file with custom built exceptions

exception gie.exceptions.ApiError[source]

Bases: Exception

Custom built exception for errors with the API

exception gie.exceptions.NoMatchingDataError[source]

Bases: Exception

Custom built exception for No matching data

gie.gie_pandas_client module

class gie.gie_pandas_client.GiePandasClient(api_key: str, session: Optional[ClientSession] = None)[source]

Bases: GieRawClient

AGSI/ALSI Pandas Client which queries the API and returns data

async query_agsi_company(company_name: Union[AGSICompany, str], start: Optional[Union[datetime, str]] = None, end: Optional[Union[datetime, str]] = None, date: Optional[Union[datetime, str]] = None, size: Optional[Union[int, str]] = None) → DataFrame[source]

Returns listing with the AGSI data for a specific company

Parameters

  • company_name (Union[AGSICompany, str]) – The name of the company to query for

  • start (Optional[Union[datetime.datetime, str]], optional) – Optional start date param, by default None

  • end (Optional[Union[datetime.datetime, str]], optional) – Optional end date param, by default None

  • date (Optional[Union[datetime.datetime, str]], optional) – Optional current date param, by default None

  • size (Optional[Union[int, str]], optional) – Optional result size param, by default None

Returns

DataFrame holding queried data

Return type

pd.DataFrame

async query_agsi_eic_listing() → DataFrame[source]

Return all the AGSI EIC (Energy Identification Code) listing

Returns

DataFrame holding the queried data

Return type

pd.DataFrame

async query_agsi_facility_storage(facility_name: Union[AGSIFacility, str], start: Optional[Union[datetime, str]] = None, end: Optional[Union[datetime, str]] = None, date: Optional[Union[datetime, str]] = None, size: Optional[Union[int, str]] = None) → DataFrame[source]

Return listing with the AGSI data for a specific facility storage

Parameters

  • facility_name (Union[AGSIFacility, str]) – The name of the facility to query for

  • start (Optional[Union[datetime.datetime, str]], optional) – Optional start date param, by default None

  • end (Optional[Union[datetime.datetime, str]], optional) – Optional end date param, by default None

  • date (Optional[Union[datetime.datetime, str]], optional) – Optional current date param, by default None

  • size (Optional[Union[int, str]], optional) – Optional result size param, by default None

Returns

DataFrame holding queried data

Return type

pd.DataFrame

async query_agsi_news_listing(news_url_item: Optional[Union[int, str]] = None) → DataFrame[source]

Return all the AGSI news or a specific country news listings

Parameters

news_url_item (Optional[Union[int, str]], optional) – An integer representing a specific country, by default None

Returns

DataFrame holding the queried data

Return type

pd.DataFrame

async query_agsi_unavailability(country: Optional[Union[AGSICountry, str]] = None, start: Optional[Union[datetime, str]] = None, end: Optional[Union[datetime, str]] = None, size: Optional[Union[int, str]] = None) → DataFrame[source]
Returns the total AGSI unavailability data or

a specific country unavailability

Parameters

  • country (Optional[Union[AGSICountry, str]], optional) – Optional country param, by default None

  • start (Optional[Union[datetime.datetime, str]], optional) – Optional start date param, by default None

  • end (Optional[Union[datetime.datetime, str]], optional) – Optional end date param, by default None

  • size (Optional[Union[int, str]], optional) – Optional result size param, by default None

Returns

DataFrame holding queried data

Return type

pd.DataFrame

async query_alsi_company(company_name: Union[ALSICompany, str], start: Optional[Union[datetime, str]] = None, end: Optional[Union[datetime, str]] = None, date: Optional[Union[datetime, str]] = None, size: Optional[Union[int, str]] = None) → DataFrame[source]

Returns listing with the ALSI data for a specific company

Parameters

  • company_name (Union[ALSICompany, str]) – The name of the company to query for

  • start (Optional[Union[datetime.datetime, str]], optional) – Optional start date param, by default None

  • end (Optional[Union[datetime.datetime, str]], optional) – Optional end date param, by default None

  • date (Optional[Union[datetime.datetime, str]], optional) – Optional current date param, by default None

  • size (Optional[Union[int, str]], optional) – Optional result size param, by default None

Returns

DataFrame holding queried data

Return type

pd.DataFrame

async query_alsi_eic_listing() → DataFrame[source]

Return all the ALSI EIC (Energy Identification Code) listing

Returns

DataFrame holding the queried data

Return type

pd.DataFrame

async query_alsi_facility_storage(facility_name: Union[ALSIFacility, str], start: Optional[Union[datetime, str]] = None, end: Optional[Union[datetime, str]] = None, date: Optional[Union[datetime, str]] = None, size: Optional[Union[int, str]] = None) → DataFrame[source]

Return listing with the ALSI data for a specific facility storage

Parameters

  • facility_name (Union[ALSIFacility, str]) – The name of the facility to query for

  • start (Optional[Union[datetime.datetime, str]], optional) – Optional start date param, by default None

  • end (Optional[Union[datetime.datetime, str]], optional) – Optional end date param, by default None

  • date (Optional[Union[datetime.datetime, str]], optional) – Optional current date param, by default None

  • size (Optional[Union[int, str]], optional) – Optional result size param, by default None

Returns

DataFrame holding queried data

Return type

pd.DataFrame

async query_alsi_news_listing(news_url_item: Optional[Union[int, str]] = None) → DataFrame[source]

Return all the ALSI news or a specific country news listings

Parameters

news_url_item (Optional[Union[int, str]], optional) – An integer representing a specific country, by default None

Returns

DataFrame holding the queried data

Return type

pd.DataFrame

async query_alsi_unavailability(country: Optional[Union[ALSICountry, str]] = None, start: Optional[Union[datetime, str]] = None, end: Optional[Union[datetime, str]] = None, size: Optional[Union[int, str]] = None) → DataFrame[source]
Returns the total ALSI unavailability data or

a specific country unavailability

Parameters

  • country (Optional[Union[ALSICountry, str]], optional) – Optional country param, by default None

  • start (Optional[Union[datetime.datetime, str]], optional) – Optional start date param, by default None

  • end (Optional[Union[datetime.datetime, str]], optional) – Optional end date param, by default None

  • size (Optional[Union[int, str]], optional) – Optional result size param, by default None

Returns

DataFrame holding queried data

Return type

pd.DataFrame

async query_country_agsi_storage(country: Optional[Union[AGSICountry, str]] = None, start: Optional[Union[datetime, str]] = None, end: Optional[Union[datetime, str]] = None, date: Optional[Union[datetime, str]] = None, size: Optional[Union[int, str]] = None) → DataFrame[source]
Return listing with the AGSI storage data for a

specific country or all countries

Parameters

  • country (Optional[Union[AGSICountry, str]], optional) – Optional country param, by default None

  • start (Optional[Union[datetime.datetime, str]], optional) – Optional starting date param, by default None

  • end (Optional[Union[datetime.datetime, str]], optional) – Optional end date param, by default None

  • date (Optional[Union[datetime.datetime, str]], optional) – Optional current date param, by default None

  • size (Optional[Union[int, str]], optional) – Optional result size param, by default None

Returns

DataFrame holding queried data

Return type

pd.DataFrame

async query_country_alsi_storage(country: Optional[Union[ALSICountry, str]] = None, start: Optional[Union[datetime, str]] = None, end: Optional[Union[datetime, str]] = None, date: Optional[Union[datetime, str]] = None, size: Optional[Union[int, str]] = None) → DataFrame[source]
Return listing with the ALSI storage data for

a specific country or all countries

Parameters

  • country (Optional[Union[ALSICountry, str]], optional) – Optional country param, by default None

  • start (Optional[Union[datetime.datetime, str]], optional) – Optional start date param, by default None

  • end (Optional[Union[datetime.datetime, str]], optional) – Optional end date param, by default None

  • date (Optional[Union[datetime.datetime, str]], optional) – Optional current date param, by default None

  • size (Optional[Union[int, str]], optional) – Optional result size param, by default None

Returns

DataFrame holding queried data

Return type

pd.DataFrame

gie.gie_raw_client module

class gie.gie_raw_client.GieRawClient(api_key: str, session: Optional[ClientSession] = None)[source]

Bases: object

AGSI/ALSI Raw Client which queries the API and returns data

property api_key
async close_session() → None[source]

Close the session.

async fetch(api_type: Union[APIType, str], endpoint: Optional[str] = None, params: Optional[Dict[str, str]] = None, news_url_item: Optional[Union[int, str]] = None, start: Optional[Union[datetime, str]] = None, end: Optional[Union[datetime, str]] = None, date: Optional[Union[datetime, str]] = None, size: Optional[Union[int, str]] = None)[source]

Builds the URL and sends requests to the API.

Parameters

  • api_type (Union[APIType, str],) –

  • endpoint (Optional[str] = None,) –

  • params (Optional[Dict[str, Any][str, str]] = None,) –

  • news_url_item (Optional[Union[int, str]] = None,) –

  • start (Optional[Union[datetime.datetime, str]] = None,) –

  • end (Optional[Union[datetime.datetime, str]] = None,) –

  • date (Optional[Union[datetime.datetime, str]] = None,) –

  • size (Optional[Union[int, str]] = None,) –

Return type

Returns the desired data according to the pointed params.

async query_agsi_company(company_name: Union[AGSICompany, str], start: Optional[Union[datetime, str]] = None, end: Optional[Union[datetime, str]] = None, date: Optional[Union[datetime, str]] = None, size: Optional[Union[int, str]] = None) → Dict[str, Any][source]

Returns listing with the AGSI data for a specific company

Parameters

  • company_name (Union[AGSICompany, str]) – The name of the company to query for

  • start (Optional[Union[datetime.datetime, str]], optional) – Optional start date param, by default None

  • end (Optional[Union[datetime.datetime, str]], optional) – Optional end date param, by default None

  • date (Optional[Union[datetime.datetime, str]], optional) – Optional current date param, by default None

  • size (Optional[Union[int, str]], optional) – Optional result size param, by default None

Returns

Object holding queried data

Return type

Dict[str, Any]

async query_agsi_eic_listing() → Dict[str, Any][source]

Return all the AGSI EIC (Energy Identification Code) listing.

Returns

Object holding the data

Return type

Dict[str, Any]

async query_agsi_facility_storage(facility_name: Union[AGSIFacility, str], start: Optional[Union[datetime, str]] = None, end: Optional[Union[datetime, str]] = None, date: Optional[Union[datetime, str]] = None, size: Optional[Union[int, str]] = None) → Dict[str, Any][source]

Return listing with the AGSI data for a specific facility storage

Parameters

  • facility_name (Union[ALSIFacility, str]) – The name of the facility to query for

  • start (Optional[Union[datetime.datetime, str]], optional) – Optional start date param, by default None

  • end (Optional[Union[datetime.datetime, str]], optional) – Optional end date param, by default None

  • date (Optional[Union[datetime.datetime, str]], optional) – Optional current date param, by default None

  • size (Optional[Union[int, str]], optional) – Optional result size param, by default None

Returns

Object holding queried data

Return type

Dict[str, Any]

async query_agsi_news_listing(news_url_item: Optional[Union[int, str]] = None) → Dict[str, Any][source]

Return all the AGSI news or a specific country news listings

Parameters

news_url_item (Optional[Union[int, str]], optional) – An integer representing a specific country, by default None

Returns

Object holding the data

Return type

Dict[str, Any]

async query_agsi_unavailability(country: Optional[Union[AGSICountry, str]] = None, start: Optional[Union[datetime, str]] = None, end: Optional[Union[datetime, str]] = None, size: Optional[Union[int, str]] = None) → Dict[str, Any][source]
Returns the total AGSI unavailability data or

a specific country unavailability

Parameters

  • country (Optional[Union[AGSICountry, str]], optional) – Optional country param, by default None

  • start (Optional[Union[datetime.datetime, str]], optional) – Optional start date param, by default None

  • end (Optional[Union[datetime.datetime, str]], optional) – Optional end date param, by default None

  • size (Optional[Union[int, str]], optional) – Optional result size param, by default None

Returns

Object holding queried data

Return type

Dict[str, Any]

async query_alsi_company(company_name: Union[ALSICompany, str], start: Optional[Union[datetime, str]] = None, end: Optional[Union[datetime, str]] = None, date: Optional[Union[datetime, str]] = None, size: Optional[Union[int, str]] = None) → Dict[str, Any][source]

Returns listing with the ALSI data for a specific company

Parameters

  • company_name (Union[AGSICompany, str]) – The name of the company to query for

  • start (Optional[Union[datetime.datetime, str]], optional) – Optional start date param, by default None

  • end (Optional[Union[datetime.datetime, str]], optional) – Optional end date param, by default None

  • date (Optional[Union[datetime.datetime, str]], optional) – Optional current date param, by default None

  • size (Optional[Union[int, str]], optional) – Optional result size param, by default None

Returns

Object holding queried data

Return type

Dict[str, Any]

async query_alsi_eic_listing() → Dict[str, Any][source]

Return all the AGSI EIC (Energy Identification Code) listing.

Returns

Object holding the data

Return type

Dict[str, Any]

async query_alsi_facility_storage(facility_name: Union[ALSIFacility, str], start: Optional[Union[datetime, str]] = None, end: Optional[Union[datetime, str]] = None, date: Optional[Union[datetime, str]] = None, size: Optional[Union[int, str]] = None) → Dict[str, Any][source]

Return listing with the ALSI data for a specific facility storage

Parameters

  • facility_name (Union[ALSIFacility, str]) – The name of the facility to query for

  • start (Optional[Union[datetime.datetime, str]], optional) – Optional start date param, by default None

  • end (Optional[Union[datetime.datetime, str]], optional) – Optional end date param, by default None

  • date (Optional[Union[datetime.datetime, str]], optional) – Optional current date param, by default None

  • size (Optional[Union[int, str]], optional) – Optional result size param, by default None

Returns

Object holding queried data

Return type

Dict[str, Any]

async query_alsi_news_listing(news_url_item: Optional[Union[int, str]] = None) → Dict[str, Any][source]

Return all the ALSI news or a specific country news listings

Parameters

news_url_item (Optional[Union[int, str]], optional) – An integer representing a specific country, by default None

Returns

Object holding the data

Return type

Dict[str, Any]

async query_alsi_unavailability(country: Optional[Union[ALSICountry, str]] = None, start: Optional[Union[datetime, str]] = None, end: Optional[Union[datetime, str]] = None, size: Optional[Union[int, str]] = None) → Dict[str, Any][source]
Returns the total ALSI unavailability data or

a specific country unavailability

Parameters

  • country (Optional[Union[AGSICountry, str]], optional) – Optional country param, by default None

  • start (Optional[Union[datetime.datetime, str]], optional) – Optional start date param, by default None

  • end (Optional[Union[datetime.datetime, str]], optional) – Optional end date param, by default None

  • size (Optional[Union[int, str]], optional) – Optional result size param, by default None

Returns

Object holding queried data

Return type

Dict[str, Any]

async query_country_agsi_storage(country: Optional[Union[AGSICountry, str]] = None, start: Optional[Union[datetime, str]] = None, end: Optional[Union[datetime, str]] = None, date: Optional[Union[datetime, str]] = None, size: Optional[Union[int, str]] = None) → Dict[str, Any][source]
Return listing with the AGSI storage data for

a specific country or all countries

Parameters

  • country (Optional[Union[ALSICountry, str]], optional) – Optional country param, by default None

  • start (Optional[Union[datetime.datetime, str]], optional) – Optional start date param, by default None

  • end (Optional[Union[datetime.datetime, str]], optional) – Optional end date param, by default None

  • date (Optional[Union[datetime.datetime, str]], optional) – Optional current date param, by default None

  • size (Optional[Union[int, str]], optional) – Optional result size param, by default None

Returns

Object holding queried data

Return type

Dict[str, Any]

async query_country_alsi_storage(country: Optional[Union[ALSICountry, str]] = None, start: Optional[Union[datetime, str]] = None, end: Optional[Union[datetime, str]] = None, date: Optional[Union[datetime, str]] = None, size: Optional[Union[int, str]] = None) → Dict[str, Any][source]
Return listing with the ALSI storage data for

a specific country or all countries

Parameters

  • country (Optional[Union[ALSICountry, str]], optional) – Optional country param, by default None

  • start (Optional[Union[datetime.datetime, str]], optional) – Optional start date param, by default None

  • end (Optional[Union[datetime.datetime, str]], optional) – Optional end date param, by default None

  • date (Optional[Union[datetime.datetime, str]], optional) – Optional current date param, by default None

  • size (Optional[Union[int, str]], optional) – Optional result size param, by default None

Returns

Object holding queried data

Return type

Dict[str, Any]

gie.lookup_functions module

gie.lookup_functions.lookup_agsi_company(key: Union[AGSICompany, str]) → AGSICompany[source]

Key lookup for AGSICompany

If the key is already of type AGSICompany, returns it immediately.

Parameters

key (Union[AGSICompany, str]) – The key to use for the lookup.

Returns

The corresponding instance of AGSICompany for which the value equals the lookup key.

Return type

AGSICompany

Raises

ValueError – If key does not represent a valid company.

gie.lookup_functions.lookup_alsi_company(key: Union[ALSICompany, str]) → ALSICompany[source]

Key lookup for ALSICompany

Parameters

key (Union[ALSICompany, str]) – The key to use for the lookup.

Returns

The corresponding instance of ALSICompany for which the value equals the lookup key.

Return type

AGSICompany

Raises

ValueError – If ‘key’ does not represent a valid company.

gie.lookup_functions.lookup_country_agsi(key: Union[AGSICountry, str]) → AGSICountry[source]

Key lookup for AGSICountry

Parameters

key (Union[AGSICountry, str]) – The key to use for the lookup.

Returns

The corresponding instance of AGSICountry for which the value equals the lookup key.

Return type

AGSICountry

Raises

ValueError – If ‘key’ does not represent a valid country.

gie.lookup_functions.lookup_country_alsi(key: Union[ALSICountry, str]) → ALSICountry[source]

Key lookup for ALSICountry

Parameters

key (Union[ALSICountry, str]) – The key to use for the lookup.

Returns

The corresponding instance of ALSICountry for which the value equals the lookup key.

Return type

ALSICountry

Raises

ValueError – If ‘key’ does not represent a valid country.

gie.lookup_functions.lookup_facility_agsi(key: Union[AGSIFacility, str]) → AGSIFacility[source]

Key lookup for AGSIFacility

If the key is already of type AGSIFacility, returns it immediately.

Parameters

key (Union[AGSIFacility, str]) – The key to use for the lookup.

Returns

The corresponding instance of AGSIFacility for which the value equals the lookup key.

Return type

AGSIFacility

Raises

ValueError – If key does not represent a valid company.

gie.lookup_functions.lookup_facility_alsi(key: Union[ALSIFacility, str]) → ALSIFacility[source]

Key lookup for ALSIFacility

If the key is already of type ALSIFacility, returns it immediately.

Parameters

key (Union[ALSIFacility, str]) – The key to use for the lookup.

Returns

The corresponding instance of ALSIFacility for which the value equals the lookup key.

Return type

ALSIFacility

Raises

ValueError – If key does not represent a valid company.

Module contents