Merge pull request #5 from M4RC0Sx/develop

Merge develop

.github/workflows/test.yml

@@ -0,0 +1,63 @@
+name: test
+on:
+    push:
+      branches:
+        - develop
+    pull_request:
+      types:
+        - opened
+        - synchronize
+
+jobs:
+    release:
+        runs-on: ubuntu-latest
+        permissions:
+            contents: write
+        steps:
+            #----------------------------------------------
+            #       Check-out repo
+            #----------------------------------------------
+            - name: Checkout
+              uses: actions/checkout@v4
+              with:
+                fetch-depth: 0
+
+            #----------------------------------------------
+            #       Install Python and Poetry
+            #       It uses .python-version file
+            #----------------------------------------------
+            - name: Set up Python
+              uses: actions/setup-python@v5
+              id: setup-python
+            - name: Install Poetry
+              uses: snok/install-poetry@v1
+              with: 
+                version: 1.8.3
+                virtualenvs-create: true
+                virtualenvs-in-project: false
+                virtualenvs-path: ~/venvs
+                installer-parallel: true
+
+            #----------------------------------------------
+            #       Cache venv
+            #----------------------------------------------
+            - name: Cache venv
+              uses: actions/cache@v4
+              id: cached-poetry-dependencies
+              with:
+                path: ~/venvs
+                key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
+
+            #----------------------------------------------
+            #       Install dependencies if cache miss
+            #----------------------------------------------
+            - name: Install dependencies
+              if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
+              run: poetry install --no-interaction --no-root
+
+            #----------------------------------------------
+            #       Run tests
+            #----------------------------------------------
+            - name: Run tests
+              run: poetry run pytest
+

README.md

@@ -1,2 +1,120 @@
 # esiosapy
-Unofficial ESIOS API Python library. Up to date and fully equipped.
+
+
+<p align="center">
+    <em>Unofficial ESIOS API Python library. Up to date and fully equipped.</em>
+</p>
+
+<p align="center">
+<a href="https://github.com/M4RC0Sx/esiosapy/actions/workflows/test.yml/badge.svg?branch=develop" target="_blank">
+    <img src="https://github.com/M4RC0Sx/esiosapy/actions/workflows/test.yml/badge.svg?branch=develop" alt="Test">
+</a>
+<a href="https://github.com/M4RC0Sx/esiosapy/actions/workflows/release.yml/badge.svg" target="_blank">
+    <img src="https://github.com/M4RC0Sx/esiosapy/actions/workflows/release.yml/badge.svg" alt="Release">
+</a>
+<a href="https://pypi.org/project/esiosapy" target="_blank">
+    <img src="https://img.shields.io/pypi/v/esiosapy?color=%2334D058&label=pypi%20package" alt="Package version">
+</a>
+<a href="https://pypi.org/project/esiosapy" target="_blank">
+    <img src="https://img.shields.io/pypi/pyversions/esiosapy.svg?color=%2334D058" alt="Supported Python versions">
+</a>
+</p>
+
+---
+
+```python
+from esiosapy.client import ESIOSAPYClient
+from esiosapy.models.indicator.time_trunc import TimeTrunc
+
+client = ESIOSAPYClient(
+    token="your_token"
+)
+
+indicators = client.indicators.list_all()
+indicator = indicators[0]
+
+data = indicator.get_data("2021-01-01", "2021-01-02", time_trunc=TimeTrunc.HOUR)
+```
+
+esiosapy allows you to communicate with the ESIOS/REE API in a comfortable and abstract way, so that everything is handled by objects and you will not need to write any raw request.
+
+
+## Installing esiosapy
+esiosapy is available on PyPi and it supports Python >=3.8:
+
+```bash
+pip install esiosapy
+```
+
+## User guide
+**There will be a more detailed in the future.**
+
+You need a personal token in order to use the ESIOS API. You can request it in [https://api.esios.ree.es/](https://api.esios.ree.es/)
+
+### Archives
+```python
+from esiosapy.client import ESIOSAPYClient
+from esiosapy.models.archive.archive_date_type import ArchiveDateType
+
+
+# Init client
+client = ESIOSAPYClient(
+    "your_esios_api_token"
+)
+
+# Search files by date range
+archives = client.archives.list_by_date_range(
+    "2021-01-01T00:00:00.000+01:00",
+    "2021-01-02T00:00:00.000+01:00",
+    date_type=ArchiveDateType.PUBLICATION,
+)
+
+# Get first file. here you should filter with your needed criteria
+x = archives[0]
+
+# Download file in current path, unzip and remove zip
+x.download_file(unzip=True, remove_zip=True)
+```
+
+To elaborate your filtering criteria, you can check out [the attributes of the Archive model](https://github.com/M4RC0Sx/esiosapy/blob/master/esiosapy/models/archive/archive.py).
+
+### Indicators
+```python
+from esiosapy.client import ESIOSAPYClient
+from esiosapy.models.indicator.time_trunc import TimeTrunc
+
+# Init client
+client = ESIOSAPYClient(
+    token="you_esios_api_token"
+)
+
+# Get all indicators
+indicators = client.indicators.list_all()
+
+# Get first file. here you should filter with your needed criteria
+#Usually, you are looking for a specific indicator
+indicator = indicators[0]
+
+# Get data between 2 dates, with time_trunc of 1 hour
+data = indicator.get_data("2021-01-01", "2021-01-02", time_trunc=TimeTrunc.HOUR)
+```
+
+To elaborate your filtering criteria, you can check out [the attributes of the Indicator model](https://github.com/M4RC0Sx/esiosapy/blob/master/esiosapy/models/indicator/indicator.py).
+
+
+## TO-DO List
+- [x] Archive model handling.
+- [x] Indicator model handling.
+- [x] OfferIndicator model handling.
+- [x] Add docstrings to the entire project.
+- [ ] Archive JSON model handling.
+- [ ] Auction model handling.
+- [ ] Generate wiki with/and more elaborated docs.
+- [ ] Add more unit tests.
+
+## Dependencies
+esiosapy depends on Pydantic and requests.
+
+## Contributing
+All contributions are welcome via direct contact with me or pull requests, as long as they are well elaborated and follow the conventional commits format.
+

esiosapy/client.py

@@ -29,4 +29,4 @@ def raw_request(self, url: str, headers: Dict[str, str] = {}) -> requests.Respon
         if urlparse(url).netloc == "":
             url = urljoin(self.base_url, url)
 
-        return requests.get(url, headers={"Accept": "application/json"})
+        return requests.get(url, headers=headers)

pyproject.toml

@@ -3,7 +3,7 @@ name = "esiosapy"
 version = "1.0.0"
 description = "Unofficial ESIOS API Python library. Up to date and fully equipped."
 authors = ["M4RC0Sx"]
-license = "MIT License"
+license = "GPL-3.0 License "
 readme = "README.md"
 packages = [
     { include = "esiosapy" },
@@ -20,6 +20,11 @@ ruff = "^0.1.12"
 mypy = "^1.8.0"
 types-requests = "^2.31.0.20240106"
 
+
+[tool.poetry.group.test.dependencies]
+pytest = "^8.3.2"
+pytest-mock = "^3.14.0"
+
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"
@@ -42,4 +47,7 @@ disallow_untyped_defs = true
 [tool.pydantic-mypy]
 init_forbid_extra = true
 init_typed = true
-warn_required_dynamic_aliases = true
+warn_required_dynamic_aliases = true
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]