python-esios 0.2.1__tar.gz → 0.2.2__tar.gz

{python_esios-0.2.1 → python_esios-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-esios
-Version: 0.2.1
+Version: 0.2.2
 Summary: A Python wrapper for the ESIOS API
 Home-page: https://github.com/datons/python-esios
 Author: Jesús López
@@ -26,8 +26,26 @@ This library provides a simple interface to download and preprocess the data fro
 pip install python-esios
 ```
 
+## Get token
+
+Ask for a personal token to access the ESIOS API following the [instructions from REE](https://www.esios.ree.es/es/pagina/api).
+
 ## Usage
 
+### Register the token in Python
+
+```python
+TOKEN = '343sdfewe342309gjarijgwoiret834383434524...'
+TOKEN = '<YOUR_TOKEN>'
+```
+
+Then, set the token in the environment variable `ESIOS_API_KEY`.
+
+```python
+import os
+os.environ['ESIOS_API_KEY'] = TOKEN
+```
+
 ### Instantiate the client
 
 ```python
@@ -43,5 +61,5 @@ endpoint = client.endpoint(name=?)
 
 In the tutorials below, you will learn how to download, preprocess, and visualize the data from the following endpoints:
 
-- [Indicators](https://github.com/datons/python-esios/blob/main/examples/20_Indicators/0_Steps.ipynb)
-- [Archives](https://github.com/datons/python-esios/blob/main/examples/30_Archives/0_Steps.ipynb)
+- [Indicators](https://github.com/datons/python-esios/blob/main/examples/20_Indicators/0_Steps/B1_Download.ipynb)
+- [Archives](https://github.com/datons/python-esios/blob/main/examples/30_Archives/0_Steps/B1_Download.ipynb)

{python_esios-0.2.1 → python_esios-0.2.2}/README.md

@@ -10,8 +10,26 @@ This library provides a simple interface to download and preprocess the data fro
 pip install python-esios
 ```
 
+## Get token
+
+Ask for a personal token to access the ESIOS API following the [instructions from REE](https://www.esios.ree.es/es/pagina/api).
+
 ## Usage
 
+### Register the token in Python
+
+```python
+TOKEN = '343sdfewe342309gjarijgwoiret834383434524...'
+TOKEN = '<YOUR_TOKEN>'
+```
+
+Then, set the token in the environment variable `ESIOS_API_KEY`.
+
+```python
+import os
+os.environ['ESIOS_API_KEY'] = TOKEN
+```
+
 ### Instantiate the client
 
 ```python
@@ -27,5 +45,5 @@ endpoint = client.endpoint(name=?)
 
 In the tutorials below, you will learn how to download, preprocess, and visualize the data from the following endpoints:
 
-- [Indicators](https://github.com/datons/python-esios/blob/main/examples/20_Indicators/0_Steps.ipynb)
-- [Archives](https://github.com/datons/python-esios/blob/main/examples/30_Archives/0_Steps.ipynb)
+- [Indicators](https://github.com/datons/python-esios/blob/main/examples/20_Indicators/0_Steps/B1_Download.ipynb)
+- [Archives](https://github.com/datons/python-esios/blob/main/examples/30_Archives/0_Steps/B1_Download.ipynb)

{python_esios-0.2.1 → python_esios-0.2.2}/esios/client.py

@@ -3,6 +3,7 @@ import requests
 import warnings
 from .indicators import Indicators
 from .archives import Archives
+from .offer_indicators import OfferIndicators
 
 class ESIOSClient:
     def __init__(self, api_key_esios=None, api_key_premium=None):
@@ -50,5 +51,7 @@ class ESIOSClient:
             return Indicators(self)
         elif name == 'archives':
             return Archives(self)
+        elif name == 'offer_indicators':
+            return OfferIndicators(self)
         else:
             raise ValueError(f"Unknown endpoint: {name}")

{python_esios-0.2.1 → python_esios-0.2.2}/esios/indicators.py

@@ -80,7 +80,8 @@ class Indicator:
             df = df[[col for col in df.columns if 'time' not in col]]
             
             if column_name in self.metadata and column_name != 'value':
-                df.rename(columns={'value': self.metadata[column_name]}, inplace=True)
+                column_name = str(self.metadata[column_name])
+                df.rename(columns={'value': column_name}, inplace=True)
             
             return df
         else:

python_esios-0.2.2/esios/offer_indicators.py

@@ -0,0 +1,85 @@
+import pandas as pd
+from datetime import datetime, timedelta
+from bs4 import BeautifulSoup
+
+class OfferIndicators:
+    def __init__(self, client):
+        self.client = client
+
+    def _html_to_text(self, html):
+        soup = BeautifulSoup(html, 'html.parser')
+        return '\n\n'.join([p.get_text() for p in soup.find_all('p')])
+
+    def list(self):
+        endpoint = "offer_indicators"
+        data = self.client._get(endpoint, self.client.public_headers)
+        
+        indicators = data.get('indicators', [])
+        for indicator in indicators:
+            indicator['description'] = self._html_to_text(indicator['description'])
+            
+        return pd.DataFrame(indicators)
+
+    def select(self, id):
+        return OfferIndicator(self.client, id)
+
+class OfferIndicator:
+    def __init__(self, client, id):
+        self.client = client
+        self.id = id
+        self.metadata = self._get_metadata()
+
+    def _get_metadata(self):
+        endpoint = f"offer_indicators/{self.id}"
+        data = self.client._get(endpoint, self.client.public_headers).get('indicator', {})
+        data.pop('values')
+        return data
+
+    def historical(self, start=None, end=None, locale='es'):
+        params = {
+            'start_date': start,
+            'end_date': end,
+            'locale': locale
+        }
+        
+        # Remove None values from params
+        params = {k: v for k, v in params.items() if v is not None}
+        
+        start_date = datetime.strptime(start, '%Y-%m-%d')
+        end_date = datetime.strptime(end, '%Y-%m-%d')
+        three_weeks = timedelta(days=3)
+
+        data_all = []
+
+        current_start = start_date
+        while current_start < end_date:
+            current_end = min(current_start + three_weeks, end_date)
+            chunk_params = params.copy()
+            chunk_params['start_date'] = current_start.strftime('%Y-%m-%d')
+            chunk_params['end_date'] = current_end.strftime('%Y-%m-%d')
+
+            endpoint = f"offer_indicators/{self.id}"
+            data = self.client._get(endpoint, self.client.public_headers, params=chunk_params)
+            data_all.extend(data.get('indicator', {}).get('values', []))
+
+            current_start = current_end + timedelta(days=1)
+
+        return self._to_dataframe(data_all)
+
+    def _to_dataframe(self, data):
+        if data:
+            df = pd.DataFrame(data)
+            if 'datetime' in df.columns:
+                df['datetime'] = pd.to_datetime(df['datetime'], utc=True)
+                df = df.set_index('datetime')
+                df.index = df.index.tz_convert('Europe/Madrid')
+            
+            df = df[[col for col in df.columns if 'time' not in col]]
+            
+            return df
+        else:
+            return pd.DataFrame()
+
+    def forecast(self):
+        # Implement forecast functionality similar to historical
+        pass

{python_esios-0.2.1 → python_esios-0.2.2}/python_esios.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-esios
-Version: 0.2.1
+Version: 0.2.2
 Summary: A Python wrapper for the ESIOS API
 Home-page: https://github.com/datons/python-esios
 Author: Jesús López
@@ -26,8 +26,26 @@ This library provides a simple interface to download and preprocess the data fro
 pip install python-esios
 ```
 
+## Get token
+
+Ask for a personal token to access the ESIOS API following the [instructions from REE](https://www.esios.ree.es/es/pagina/api).
+
 ## Usage
 
+### Register the token in Python
+
+```python
+TOKEN = '343sdfewe342309gjarijgwoiret834383434524...'
+TOKEN = '<YOUR_TOKEN>'
+```
+
+Then, set the token in the environment variable `ESIOS_API_KEY`.
+
+```python
+import os
+os.environ['ESIOS_API_KEY'] = TOKEN
+```
+
 ### Instantiate the client
 
 ```python
@@ -43,5 +61,5 @@ endpoint = client.endpoint(name=?)
 
 In the tutorials below, you will learn how to download, preprocess, and visualize the data from the following endpoints:
 
-- [Indicators](https://github.com/datons/python-esios/blob/main/examples/20_Indicators/0_Steps.ipynb)
-- [Archives](https://github.com/datons/python-esios/blob/main/examples/30_Archives/0_Steps.ipynb)
+- [Indicators](https://github.com/datons/python-esios/blob/main/examples/20_Indicators/0_Steps/B1_Download.ipynb)
+- [Archives](https://github.com/datons/python-esios/blob/main/examples/30_Archives/0_Steps/B1_Download.ipynb)

{python_esios-0.2.1 → python_esios-0.2.2}/python_esios.egg-info/SOURCES.txt

@@ -5,6 +5,7 @@ esios/__init__.py
 esios/archives.py
 esios/client.py
 esios/indicators.py
+esios/offer_indicators.py
 python_esios.egg-info/PKG-INFO
 python_esios.egg-info/SOURCES.txt
 python_esios.egg-info/dependency_links.txt

{python_esios-0.2.1 → python_esios-0.2.2}/setup.py

@@ -7,7 +7,7 @@ long_description = (this_directory / "README.md").read_text(encoding='utf-8')
 
 setup(
     name='python-esios',
-    version='0.2.1',
+    version='0.2.2',
     packages=find_packages(),
     install_requires=[
         'requests',