saviialib 1.3.0__py3-none-any.whl → 1.5.0__py3-none-any.whl

saviialib/services/{epii → thies}/use_cases/update_thies_data.py

@@ -1,4 +1,4 @@
-from saviialib.general_types.error_types.api.epii_api_error_types import (
+from saviialib.general_types.error_types.api.saviia_api_error_types import (
     SharePointFetchingError,
     SharePointDirectoryError,
     SharePointUploadError,
@@ -26,16 +26,17 @@ from saviialib.libs.sharepoint_client import (
 from saviialib.libs.directory_client import DirectoryClient, DirectoryClientArgs
 
 from saviialib.libs.files_client import FilesClient, FilesClientInitArgs, WriteArgs
-from saviialib.services.epii.use_cases.types import (
+from saviialib.services.backup.use_cases.types import (
     FtpClientConfig,
     SharepointConfig,
     UpdateThiesDataUseCaseInput,
 )
-from saviialib.services.epii.utils import (
+from saviialib.services.backup.utils import (
     parse_execute_response,
 )
 from saviialib.libs.zero_dependency.utils.datetime_utils import today, datetime_to_str
 from .components.create_thies_statistics_file import create_thies_daily_statistics_file
+from typing import Set, Dict, List
 
 
 class UpdateThiesDataUseCase:
@@ -95,7 +96,7 @@ class UpdateThiesDataUseCase:
                     reason=f"The current folder '{folder_name}' doesn't exist."
                 )
 
-    async def fetch_cloud_file_names(self) -> set[str]:
+    async def fetch_cloud_file_names(self) -> Set[str]:
         """Fetch file names from the RCER cloud."""
         await self._validate_sharepoint_current_folders()
         try:
@@ -113,7 +114,7 @@ class UpdateThiesDataUseCase:
         except Exception as error:
             raise SharePointFetchingError(reason=error)
 
-    async def fetch_thies_file_names(self) -> set[str]:
+    async def fetch_thies_file_names(self) -> Set[str]:
         """Fetch file names from the THIES FTP server."""
         try:
             thies_files = set()
@@ -131,7 +132,7 @@ class UpdateThiesDataUseCase:
         except ConnectionAbortedError as error:
             raise ThiesFetchingError(reason=error)
 
-    async def fetch_thies_file_content(self) -> dict[str, bytes]:
+    async def fetch_thies_file_content(self) -> Dict[str, bytes]:
         """Fetch the content of files from the THIES FTP server."""
         try:
             content_files = {}
@@ -165,8 +166,8 @@ class UpdateThiesDataUseCase:
             raise ThiesFetchingError(reason=error)
 
     async def upload_thies_files_to_sharepoint(
-        self, files: dict
-    ) -> dict[str, list[str]]:
+        self, files: Dict
+    ) -> Dict[str, List[str]]:
         """Upload files to SharePoint and categorize the results."""
         upload_results = {"failed_files": [], "new_files": []}
 
@@ -269,7 +270,15 @@ class UpdateThiesDataUseCase:
                     FtpReadFileArgs(file_path)
                 )
             except FileNotFoundError as error:
-                raise ThiesFetchingError(reason=str(error))
+                reason = (
+                    str(error) + ". The file might not be available yet for statistics."
+                )
+                self.logger.warning("[thies_synchronization_lib] Warning: %s", reason)
+                self.logger.warning(
+                    "[thies_synchronization_lib] Skipping the creation of daily statistics %s",
+                    filename,
+                )
+                return
             # Destination local folder
             self.logger.debug(file_path)
 
@@ -305,9 +314,7 @@ class UpdateThiesDataUseCase:
                     dest_folder,
                 )
         # Read the files with ThiesDayData class
-        await create_thies_daily_statistics_file(
-            self.os_client, self.logger, daily_files
-        )
+        await create_thies_daily_statistics_file(self.os_client, self.logger)
 
     async def execute(self):
         """Synchronize data from the THIES Center to the cloud."""

saviialib-1.5.0.dist-info/METADATA

@@ -0,0 +1,126 @@
+Metadata-Version: 2.4
+Name: saviialib
+Version: 1.5.0
+Summary: A client library for IoT projects in the RCER initiative
+License: MIT
+License-File: LICENSE
+Author: pedropablozavalat
+Requires-Python: >=3.11,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: aiofiles
+Requires-Dist: aioftp
+Requires-Dist: aiohttp
+Requires-Dist: asyncssh (==2.21.1)
+Requires-Dist: bitarray
+Requires-Dist: build
+Requires-Dist: certifi
+Requires-Dist: dotenv (>=0.9.9,<0.10.0)
+Requires-Dist: ffmpeg-asyncio (==0.1.3)
+Requires-Dist: numpy (>=2.2.0,<2.4.0)
+Requires-Dist: pandas (>=2.2.3,<2.3.1)
+Description-Content-Type: text/markdown
+
+# SAVIIA Library 
+*Sistema de Administración y Visualización de Información para la Investigación y Análisis*
+
+[![GitHub release (latest by date)](https://img.shields.io/github/v/release/pedrozavalat/saviia-lib?style=for-the-badge)](https://github.com/pedrozavalat/saviia-lib/releases)
+
+
+## Installation
+This library is designed for use with the SAVIIA Home Assistant Integration. It provides an API to retrieve files from a THIES Data Logger via an FTP server and upload them to a Microsoft SharePoint folder using the SharePoint REST API.
+
+```bash
+pip install saviialib
+```
+
+## Saviia API Client Usage
+
+### Initialize the Saviia API Client
+Import the necessary classes from the library.
+```python
+from saviialib import SaviiaAPI, SaviiaAPIConfig
+```
+
+To start using the library, you need to create an `SaviiaAPI` client instance with its configuration class `SaviiaAPIConfig`. Provide the required parameters such as FTP server details and SharePoint credentials:
+```python
+config = SaviiaAPIConfig(
+    ftp_port=FTP_PORT,
+    ftp_host=FTP_HOST,
+    ftp_user=FTP_USER,
+    ftp_password=FTP_PASSWORD,
+    sharepoint_client_id=SHAREPOINT_CLIENT_ID,
+    sharepoint_client_secret=SHAREPOINT_CLIENT_SECRET,
+    sharepoint_tenant_id=SHAREPOINT_TENANT_ID,
+    sharepoint_tenant_name=SHAREPOINT_TENANT_NAME,
+    sharepoint_site_name=SHAREPOINT_SITE_NAME
+)
+```
+```python
+api_client = SaviiaAPI(config)
+```
+**Notes:** 
+- Store sensitive data like `FTP_PASSWORD`, `FTP_USER`, and SharePoint credentials securely. Use environment variables or a secrets management tool to avoid hardcoding sensitive information in your codebase.
+
+### Access THIES Data Logger Services
+To interact with the THIES Data Logger services, you can access the `thies` attribute of the `SaviiaAPI` instance:
+```python
+thies_client = api_client.get('thies')
+```
+This instance provides methods to interact with the THIES Data Logger. Currently, it includes the main method for extracting files from the FTP server and uploading them to SharePoint.
+
+#### THIES files extraction and synchronization
+The library provides a method to extract and synchronize THIES Data Logger files with the Microsoft SharePoint client. This method downloads files from the FTP server and uploads them to the specified SharePoint folder:
+```python 
+import asyncio
+async def main():
+    # Before calling this method, you must have initialised the THIES service class ...
+    response = await thies_client.update_thies_data()
+    return response
+
+asyncio.run(main())
+```
+
+### Access Backup Services
+To interact with the Backup services, you can access the `backup` attribute of the `SaviiaAPI` instance:
+```python
+backup_client = api_client.get('backup')
+```
+This instance provides methods to interact with the Backup services. Currently, it includes the main method for creating backups of specified directories in a local folder from Home Assistant environment. Then each backup file is uploaded to a Microsoft SharePoint folder.
+
+#### Create Backup
+The library provides a method which creates a backup of a specified directory in a local folder from Home Assistant environment. Then each backup file is uploaded to a Microsoft SharePoint folder: 
+
+```python
+import asyncio
+async def main():
+    # Before calling this method, you must have initialised the Backup service class ...
+    response = await backup_client.upload_backup_to_sharepoint(
+        local_backup_path=LOCAL_BACKUP_PATH,
+        sharepoint_folder_path=SHAREPOINT_FOLDER_PATH
+    )
+    return response
+asyncio.run(main())
+```
+**Notes:**
+- Ensure that the `local_backup_path` exists and contains the files you want to back up. It is a relative path from the Home Assistant configuration directory.
+- The `sharepoint_folder_path` should be the path to the folder in SharePoint where you want to upload the backup files. For example, if your url is `https://yourtenant.sharepoint.com/sites/yoursite/Shared Documents/Backups`, the folder path would be `sites/yoursite/Shared Documents/Backups`.
+
+
+
+
+
+
+
+## Contributing
+If you're interested in contributing to this project, please follow the contributing guidelines. By contributing to this project, you agree to abide by its terms.
+Contributions are welcome and appreciated!
+
+## License
+
+`saviialib` was created by Pedro Pablo Zavala Tejos. It is licensed under the terms of the MIT license.
+

saviialib-1.5.0.dist-info/RECORD

@@ -0,0 +1,87 @@
+saviialib/__init__.py,sha256=pn4KYFwPsVe43mw1e0svWiqA0StzM2B5Cr0iPc481I0,3074
+saviialib/general_types/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+saviialib/general_types/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+saviialib/general_types/api/saviia_api_types.py,sha256=kX45V3KQb48S1jEstXcAtbiemVUgemJE_XK5qP7BJm0,1318
+saviialib/general_types/api/saviia_backup_api_types.py,sha256=mtXRxFjBOqfUBWWtgLZxNq-vb_mBkCUS9fxoFRJfoYE,791
+saviialib/general_types/api/saviia_netcamera_api_types.py,sha256=WVA3VP_FiTGPhtTl8GCG2RAVo7YDS5TTyl-0I5rUK4Y,208
+saviialib/general_types/api/saviia_shakes_api_types.py,sha256=XlLwfCyFeQXk9kH7H0EcUJHIigj9edFKgn3wKGJ1Z94,623
+saviialib/general_types/api/saviia_thies_api_types.py,sha256=ueqOFjHvRuT-N8H1UZEVXErgK1S1iRw0AXeO8bTdBts,1017
+saviialib/general_types/error_types/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+saviialib/general_types/error_types/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+saviialib/general_types/error_types/api/saviia_api_error_types.py,sha256=BcDhteS4KsFNCm3L9ZQJTQKs0bKRXq3LgM4mfxsW-HY,3270
+saviialib/general_types/error_types/api/saviia_netcamera_error_types.py,sha256=ipdY8PDJOFLxjgUIWc09cuaiHzPtBvAb7YKoosTL0wY,246
+saviialib/general_types/error_types/common/__init__.py,sha256=yOBLZbt64Ki9Q0IJ0tMAubgq7PtrQ7XQ3RgtAzyOjiE,170
+saviialib/general_types/error_types/common/common_types.py,sha256=2w790TQNRLc4UskXNHAh8RMZIJLA8FYyQbVxkPp89UA,717
+saviialib/libs/directory_client/__init__.py,sha256=ys07nzp74fHew2mUkbGpntp5w4t_PnhZIS6D4_mJw2A,162
+saviialib/libs/directory_client/client/os_client.py,sha256=mBIQc8ek8mDY6GMCX-cPNLleM4RbFdqoiuw5Ccoe3YA,763
+saviialib/libs/directory_client/directory_client.py,sha256=5HmB1Pt9M8Tk18WKzfh3Fwr8gKa_RZCdAqvbU0rg7mw,1086
+saviialib/libs/directory_client/directory_client_contract.py,sha256=wtNaUak1a7r6t9OI1L2ou7XMMJFXWpQFb7WyT6X7fCQ,479
+saviialib/libs/directory_client/types/directory_client_types.py,sha256=ncMwVs_o6EYMuypXXmVInsjVDKJsdxVkmwj1M-LEInA,109
+saviialib/libs/ffmpeg_client/__init__.py,sha256=KjOP--Uv0Z-qvoJI9IwwBrU3ZrroaC55zDG7fm9DEts,207
+saviialib/libs/ffmpeg_client/clients/ffmpeg_asyncio_client.py,sha256=eqm7sNm4BY3WaxobXbeoS39DfzfwtICgmQAm9UE7yZw,3639
+saviialib/libs/ffmpeg_client/ffmpeg_client.py,sha256=evqhjQeT9VejtJ8Gb7A3Vjxoj0PT4n7JnbbsuO7-35U,870
+saviialib/libs/ffmpeg_client/ffmpeg_client_contract.py,sha256=mvGrGYkikExz4VyAErcSu6Sd2utYYm9bqxJj1N22z2U,324
+saviialib/libs/ffmpeg_client/types/ffmpeg_client_types.py,sha256=Vo062LHqfTLgRbwLloZMRkC36CO3r9tFqY97nVxr8vE,444
+saviialib/libs/files_client/__init__.py,sha256=sIi9ne7Z3EfxnqGTaSmH-cZ8QsKyu0hoOz61GyA3njs,192
+saviialib/libs/files_client/clients/aiofiles_client.py,sha256=Mu5pSnnEa3dT3GONmt1O-lCQstuQNXHtJHM3D2L6TU8,1107
+saviialib/libs/files_client/clients/csv_client.py,sha256=Rk4QbiKlVKrYxYtxQt-Pmkp9QoB_dNgs5r36JB9hU0o,1478
+saviialib/libs/files_client/files_client.py,sha256=oWfaMLA_Lw91H1_pPirFtFbdJh4abSyZp91qBsAiePs,950
+saviialib/libs/files_client/files_client_contract.py,sha256=fYvd68IMpc1OFkxbzNSmRUoTWVctf3hkNVQ7QZV0m6I,304
+saviialib/libs/files_client/types/files_client_types.py,sha256=GOTM5fBY304-EX6IiUnWmt2JpsyQ6Nmb_Tp0wingt0M,755
+saviialib/libs/ftp_client/__init__.py,sha256=dW2Yutgc7mJJJzgKLhWKXMgQ6KIWJYfFa1sGpjHH5xU,191
+saviialib/libs/ftp_client/clients/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+saviialib/libs/ftp_client/clients/aioftp_client.py,sha256=5sgr3PMETgaBRlKeu_avxHIh6tr1gb7t2mkxmpRas_k,1925
+saviialib/libs/ftp_client/clients/ftplib_client.py,sha256=VcpAn23r03iyCUAj35xHU_AVNrll_45uHFN8Z9OnBkE,2203
+saviialib/libs/ftp_client/ftp_client.py,sha256=Naj9p0yYWlXt9um0zKfvuHSoycM8JZg2SPBm8110pYk,1008
+saviialib/libs/ftp_client/ftp_client_contract.py,sha256=tymkugDzsJ5PzUXIaSkwX1h7T0naR15qAkjrqswqDyM,338
+saviialib/libs/ftp_client/types/__init__.py,sha256=syfwf9feP4QK7fkCTfl4j8l11ic-jHtfi1DE2chaWbs,155
+saviialib/libs/ftp_client/types/ftp_client_types.py,sha256=e4SmYkewldulaD8ms2q75zVgLFXyBxBqoa_L-IQOmso,256
+saviialib/libs/sftp_client/__init__.py,sha256=f51sFOd_XIhhd6x6AZ3ZdbJ86hO1xnqAk9MmEjwRJ-c,229
+saviialib/libs/sftp_client/clients/asyncssh_sftp_client.py,sha256=vqCKHIx3K6QFujQP5DIAB5EYOz1zAdhi825LTRvhG20,3469
+saviialib/libs/sftp_client/sftp_client.py,sha256=_5HRYSBPadxZEdHuHSpQ_VrwerBfu24izNRg-pvLzlU,918
+saviialib/libs/sftp_client/sftp_client_contract.py,sha256=JWWxIfNBXcsBd8z3gQHGpeRASRjtP9WGkznoMfP0IZc,365
+saviialib/libs/sftp_client/types/sftp_client_types.py,sha256=NzUZVq6yeGKkO7KF-v4Cc-rwaWeOgFCUGVPL1YBbYgA,446
+saviialib/libs/sharepoint_client/__init__.py,sha256=6RbEzFtCfMrrY8F0JOCVcK6Gqt1FBJ09m0NuWHMCmCI,384
+saviialib/libs/sharepoint_client/clients/sharepoint_rest_api.py,sha256=I3OfZ5M4uR86hLIBOlOQzGNyTzQRy1yckrLF1ne7F1g,6319
+saviialib/libs/sharepoint_client/sharepoint_client.py,sha256=gXFisWWCk6pKhoEeaNN8dcHA5ywrGDLqfiKjchrHRy0,1816
+saviialib/libs/sharepoint_client/sharepoint_client_contract.py,sha256=H-WsXR5f50jy5RRYNlgV61y_YGjOUq4U_E1DWUUrDYw,612
+saviialib/libs/sharepoint_client/types/sharepoint_client_types.py,sha256=JruUCn6o16w00t4zxDrxmv_Bxa52UyShGYmwUFfBCCQ,482
+saviialib/libs/zero_dependency/utils/datetime_utils.py,sha256=c2H_JpUKpunCzDw6I4alDWNftEqaciWGtEUklPepm_s,759
+saviialib/libs/zero_dependency/utils/strings_utils.py,sha256=XqEukvCLkQ0PhjjPm9FTjrzbwBYMejs-0uSoLwSxhPo,133
+saviialib/services/backup/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+saviialib/services/backup/api.py,sha256=S1dMGyyjYzVyo-E8FMttHZMOO2TtQoAMaLp-oquW46g,1408
+saviialib/services/backup/controllers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+saviialib/services/backup/controllers/types/__init__.py,sha256=0zIWXQb6YQVIIbb5b_FeL-D9Zy_d1GqR8kVz3hen4IU,222
+saviialib/services/backup/controllers/types/upload_backup_to_sharepoint_types.py,sha256=AzoHx3AWrVCM8LjmlEovDlRe4kJPJBbRoMToG8QK_Nw,464
+saviialib/services/backup/controllers/upload_backup_to_sharepoint.py,sha256=rW8FmcalRO1Ip8rhOsfpJIKRVYyn8oO-_jJSiS7MJOk,3827
+saviialib/services/backup/use_cases/constants/upload_backup_to_sharepoint_constants.py,sha256=erkn-3E8YwBMFs25o7exXoK7s73NdgP9IYDXeWzALcI,98
+saviialib/services/backup/use_cases/types/__init__.py,sha256=uVfu-L3-2QGnki0-rL2fOVTj4hVMvykyqKEv7kQHNvE,224
+saviialib/services/backup/use_cases/types/upload_backup_to_sharepoint_types.py,sha256=QSZ32Fsan-jGpmGFpip86N3S16oWaeIxri5at2x46nw,322
+saviialib/services/backup/use_cases/upload_backup_to_sharepoint.py,sha256=tBAfztcXdr3pmJqhwdHKc6AbddajZubs_wkL93Wajv4,11890
+saviialib/services/backup/utils/__init__.py,sha256=Khz07TAC17xGBbkSgNcOXSjzeFm6-NiQadNJ3R7tRgg,112
+saviialib/services/backup/utils/upload_backup_to_sharepoint_utils.py,sha256=J2PkLvNFHqka4NLW4lrAdaK5pRgHnU3ZSOflO43uu78,3530
+saviialib/services/netcamera/api.py,sha256=W8ZKfh_iGEvfE36yGXYH9RlveUUtHoxQI_E3__YGfq0,1182
+saviialib/services/netcamera/controllers/get_media_files.py,sha256=CEfZ7YRhXBcuGeK3HWB3Bpp-i-pIvAs70krreCHL_eA,1507
+saviialib/services/netcamera/controllers/types/get_media_files_types.py,sha256=40V0ARqtloRM16KYYxzeq5aQU-mrghEK7FfkeFoSmbk,417
+saviialib/services/netcamera/use_cases/get_media_files.py,sha256=ct_MOOgxzqCURQo2JJx1ioBaO-Qq-Gj-27Y4JAdZbeo,2801
+saviialib/services/netcamera/use_cases/types/get_media_files_types.py,sha256=XCpodI-WdZYbhd3DD1LkKDgLTSRKlXkHClbhwT8zXm8,333
+saviialib/services/shakes/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+saviialib/services/shakes/api.py,sha256=WvmOJ35lPdJuqSEl9-q9VOGNxqkqvzfBUmkp-G8WKj4,1230
+saviialib/services/shakes/controllers/get_miniseed_files.py,sha256=k55QiIQoNHyMQsgW939IbrPY4tHy8cFMg51LDVQQSgs,1934
+saviialib/services/shakes/controllers/types/get_miniseed_files_types.py,sha256=LZ8LZxpjPYrl-EIuwQixXl8z4Ygl81DgodoHyxzvIxY,366
+saviialib/services/shakes/use_cases/get_miniseed_files.py,sha256=HD6VphToOF8eq-J281qOg9AgeD6hFAsVfScwvP5c9jc,3033
+saviialib/services/shakes/use_cases/types/get_miniseed_files_types.py,sha256=bb5XurP08pHhhNK80dvgoSP_OmHFEdKhT-jzyd8w5kk,385
+saviialib/services/shakes/use_cases/utils/get_miniseed_files_utils.py,sha256=6TEdu9MglnM0_FTuxs9BETneXqQBUGb-Q1rDKhvRLvg,288
+saviialib/services/thies/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+saviialib/services/thies/api.py,sha256=ibXBSzs_LJjZbC9LWh1EcHMWUp5qWTz-P_qOIb3rx6Y,1365
+saviialib/services/thies/controllers/types/update_thies_data_types.py,sha256=YSLd0HgkeB7auTXFjZVYz_g9jv2hY2vaK7x6VLZ2BK4,439
+saviialib/services/thies/controllers/update_thies_data.py,sha256=j_orYJfom4lo8xm8Jsru1h8JjDFI4xAfUL2oSM_XpcE,4890
+saviialib/services/thies/use_cases/components/create_thies_statistics_file.py,sha256=_1wY_yI_Lg2QTOGag4lVZBWM3B1gp2Duz7ore-kOHhQ,5575
+saviialib/services/thies/use_cases/components/thies_bp.py,sha256=1Iq5Wz3kqzJfQNawV_v8ORr_Pl-PoamFp_2Xo8DjvmI,15042
+saviialib/services/thies/use_cases/types/update_thies_data_types.py,sha256=S9_oS4Laygh_XIQoKWzaLd9QrAjVajyHcgJgbzEFPww,554
+saviialib/services/thies/use_cases/update_thies_data.py,sha256=6l3AvFRwDMTCChJfMR_f1Y6ejDNiy9eKlD1mfxqFjPw,14962
+saviialib/services/thies/utils/update_thies_data_utils.py,sha256=EpjYWXqyHxJ-dO3MHhdXp-rGV7WyUckeFko-nnfnNac,555
+saviialib-1.5.0.dist-info/METADATA,sha256=gp3HoVlafLCIXXrjex5UmaJHV-2a8uBYpap7EzpkAEk,5235
+saviialib-1.5.0.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
+saviialib-1.5.0.dist-info/licenses/LICENSE,sha256=NWpf6b38xgBWPBo5HZsCbdfp9hZSliEbRqWQgm0fkOo,1076
+saviialib-1.5.0.dist-info/RECORD,,

{saviialib-1.3.0.dist-info → saviialib-1.5.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 2.1.3
+Generator: poetry-core 2.2.1
 Root-Is-Purelib: true
 Tag: py3-none-any

saviialib/services/epii/api.py

@@ -1,94 +0,0 @@
-from typing import Any, Dict, List
-
-from .controllers.types.update_thies_data_types import UpdateThiesDataControllerInput
-from .controllers.types.upload_backup_to_sharepoint_types import (
-    UploadBackupToSharepointControllerInput,
-)
-from .controllers.update_thies_data import UpdateThiesDataController
-from .controllers.upload_backup_to_sharepoint import UploadBackupToSharepointController
-from saviialib.general_types.api.epii_api_types import (
-    EpiiUpdateThiesConfig,
-    EpiiSharepointBackupConfig,
-    EpiiAPIConfig,
-)
-
-
-class EpiiAPI:
-    """
-    EpiiAPI is a service class that provides methods to interact with Patagonia Center system.
-    """
-
-    def __init__(self, config: EpiiAPIConfig):
-        self.ftp_port = config.ftp_port
-        self.ftp_host = config.ftp_host
-        self.ftp_user = config.ftp_user
-        self.ftp_password = config.ftp_password
-        self.sharepoint_client_id = config.sharepoint_client_id
-        self.sharepoint_client_secret = config.sharepoint_client_secret
-        self.sharepoint_tenant_id = config.sharepoint_tenant_id
-        self.sharepoint_tenant_name = config.sharepoint_tenant_name
-        self.sharepoint_site_name = config.sharepoint_site_name
-        self.logger = config.logger
-
-    async def update_thies_data(
-        self, sharepoint_folders_path: List[str], ftp_server_folders_path: List[str]
-    ) -> Dict[str, Any]:
-        """Updates data from a THIES Data Logger by connecting to an FTP server
-        and transferring data to specified Sharepoint folders.
-
-        Args:
-            sharepoint_folders_path (list): List of Sharepoint folder paths for AVG and EXT data.
-            The AVG path must be the first element.
-            ftp_server_folders_path (list): List of FTP server folder paths for AVG and EXT data.
-            The AVG path must be the first element.
-
-        Returns:
-            dict: A dictionary representation of the API response.
-        """
-        config = EpiiUpdateThiesConfig(
-            ftp_port=self.ftp_port,
-            ftp_host=self.ftp_host,
-            ftp_user=self.ftp_user,
-            ftp_password=self.ftp_password,
-            sharepoint_client_id=self.sharepoint_client_id,
-            sharepoint_client_secret=self.sharepoint_client_secret,
-            sharepoint_site_name=self.sharepoint_site_name,
-            sharepoint_tenant_id=self.sharepoint_tenant_id,
-            sharepoint_tenant_name=self.sharepoint_tenant_name,
-            logger=self.logger,
-        )
-        controller = UpdateThiesDataController(
-            UpdateThiesDataControllerInput(
-                config, sharepoint_folders_path, ftp_server_folders_path
-            )
-        )
-        response = await controller.execute()
-        return response.__dict__
-
-    async def upload_backup_to_sharepoint(
-        self, local_backup_source_path: str, sharepoint_destination_path: str
-    ) -> Dict[str, Any]:
-        """Migrate a backup folder from Home assistant to Sharepoint directory.
-        Args:
-            local_backup_source_path (str): Local path to backup.
-        Returns:
-            response (dict): A dictionary containing the response from the upload operation.
-                This dictionary will typically include information about the success or
-                failure of the upload, as well as any relevant metadata.
-        """
-        config = EpiiSharepointBackupConfig(
-            sharepoint_client_id=self.sharepoint_client_id,
-            sharepoint_client_secret=self.sharepoint_client_secret,
-            sharepoint_site_name=self.sharepoint_site_name,
-            sharepoint_tenant_id=self.sharepoint_tenant_id,
-            sharepoint_tenant_name=self.sharepoint_tenant_name,
-            logger=self.logger,
-        )
-
-        controller = UploadBackupToSharepointController(
-            UploadBackupToSharepointControllerInput(
-                config, local_backup_source_path, sharepoint_destination_path
-            )
-        )
-        response = await controller.execute()
-        return response.__dict__

saviialib/services/epii/utils/__init__.py

@@ -1,3 +0,0 @@
-from .update_thies_data_utils import parse_execute_response
-
-__all__ = ["parse_execute_response"]

saviialib-1.3.0.dist-info/METADATA

@@ -1,122 +0,0 @@
-Metadata-Version: 2.3
-Name: saviialib
-Version: 1.3.0
-Summary: A client library for IoT projects in the RCER initiative
-License: MIT
-Author: pedropablozavalat
-Requires-Python: >=3.11,<4.0
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: aiofiles
-Requires-Dist: aioftp
-Requires-Dist: aiohttp
-Requires-Dist: bitarray
-Requires-Dist: build
-Requires-Dist: dotenv (>=0.9.9,<0.10.0)
-Requires-Dist: numpy (>=2.2.0,<2.4.0)
-Requires-Dist: pandas (>=2.2.3,<2.3.1)
-Requires-Dist: pytest-cov (>=6.1.1,<7.0.0)
-Description-Content-Type: text/markdown
-
-# SAVIIA Library 
-*Sistema de Administración y Visualización de Información para la Investigación y Análisis*
-
-[![GitHub release (latest by date)](https://img.shields.io/github/v/release/pedrozavalat/saviia-lib?style=for-the-badge)](https://github.com/pedrozavalat/saviia-lib/releases)
-
-
-## Installation
-This library is designed for use with the SAVIIA Home Assistant Integration. It provides an API to retrieve files from a THIES Data Logger via an FTP server and upload them to a Microsoft SharePoint folder using the SharePoint REST API.
-
-```bash
-pip install saviialib
-```
-
-## Usage
-
-### Initialize the EPii API Client
-To start using the library, you need to create an `EpiiAPI` client instance with its configuration class:
-
-```python
-from saviialib import EpiiAPI, EpiiAPIConfig
-config = EpiiAPIConfig(
-        ftp_port=FTP_PORT,
-        ftp_host=FTP_HOST,
-        ftp_user=FTP_USER,
-        ftp_password=FTP_PASSWORD,
-        sharepoint_client_id=SHAREPOINT_CLIENT_ID,
-        sharepoint_client_secret=SHAREPOINT_CLIENT_SECRET,
-        sharepoint_tenant_id=SHAREPOINT_TENANT_ID,
-        sharepoint_tenant_name=SHAREPOINT_TENANT_NAME,
-        sharepoint_site_name=SHAREPOINT_SITE_NAME
-    )
-api_client = EpiiAPI(config)
-```
-**Notes:** 
-- Store sensitive data like `FTP_PASSWORD`, `FTP_USER`, and SharePoint credentials securely. Use environment variables or a secrets management tool to avoid hardcoding sensitive information in your codebase.
-
-### Update THIES Data Logger Files
-The library provides a method to synchronize THIES Data Logger files with the RCER SharePoint client. This method updates the folder containing binary files with meteorological data:
-
-```python
-from saviialib import EpiiUpdateThiesConfig
-import asyncio
-
-async def main():
-    # Before calling this method, you must have initialised the api class ...
-    response = await api_client.update_thies_data()
-    return response
-
-asyncio.run(main())
-```
-
-## Development
-
-This project includes a `Makefile` to simplify common tasks. Below are the available commands:
-
-### Install Basic Dependencies
-To install the basic dependencies required for the project, run the following command:
-
-```bash
-make install-deps
-```
-
-This will ensure that all necessary libraries and tools are installed for the project to function properly.
-
-### Install Development Requirements
-For setting up a development environment with additional tools and libraries, execute:
-
-```bash
-make dev
-```
-
-This command installs all the dependencies needed for development, including testing and linting tools.
-
-### Run Tests
-To verify that the code is functioning as expected, you can run the test suite using:
-
-```bash
-make test
-```
-
-This will execute all the tests in the project and provide a summary of the results.
-
-### Lint the Code
-To ensure that the code adheres to the project's style guidelines and is free of common errors, run:
-
-```bash
-make lint
-```
-
-This command checks the codebase for linting issues and outputs any problems that need to be addressed.
-
-## Contributing
-If you're interested in contributing to this project, please follow the contributing guidelines. By contributing to this project, you agree to abide by its terms.
-Contributions are welcome and appreciated!
-
-## License
-
-`saviialib` was created by Pedro Pablo Zavala Tejos. It is licensed under the terms of the MIT license.
-

saviialib-1.3.0.dist-info/RECORD

@@ -1,57 +0,0 @@
-saviialib/__init__.py,sha256=TMsEY8OOjo9KOz-0jf3QBh6WFOhCY07Rd7W2PK7C-1A,253
-saviialib/general_types/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-saviialib/general_types/api/__init__.py,sha256=jXhoMlbSv7UCizW_Fm2mqR_3n99qkocVwg6CF7s3w7w,145
-saviialib/general_types/api/epii_api_types.py,sha256=jspp5tDN06qx27O3ubRyPfZ3i9ybvn2HLxjh3UTFNcY,2345
-saviialib/general_types/error_types/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-saviialib/general_types/error_types/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-saviialib/general_types/error_types/api/epii_api_error_types.py,sha256=iprpNvVoNA3vakMm7-dQdjCv7ZrRs6tRiXK1uaV3DNU,3049
-saviialib/general_types/error_types/common/__init__.py,sha256=yOBLZbt64Ki9Q0IJ0tMAubgq7PtrQ7XQ3RgtAzyOjiE,170
-saviialib/general_types/error_types/common/common_types.py,sha256=n5yuw-gVtkrtNfmaZ83ZkYxYHGl4jynOLUB9C8Tr32w,474
-saviialib/libs/directory_client/__init__.py,sha256=ys07nzp74fHew2mUkbGpntp5w4t_PnhZIS6D4_mJw2A,162
-saviialib/libs/directory_client/client/os_client.py,sha256=TgDnIQvgMP7sIVjn5kAKEJ5BYET7pN-FIQP0lvFMl4Q,763
-saviialib/libs/directory_client/directory_client.py,sha256=5HmB1Pt9M8Tk18WKzfh3Fwr8gKa_RZCdAqvbU0rg7mw,1086
-saviialib/libs/directory_client/directory_client_contract.py,sha256=wtNaUak1a7r6t9OI1L2ou7XMMJFXWpQFb7WyT6X7fCQ,479
-saviialib/libs/directory_client/types/directory_client_types.py,sha256=ncMwVs_o6EYMuypXXmVInsjVDKJsdxVkmwj1M-LEInA,109
-saviialib/libs/files_client/__init__.py,sha256=sIi9ne7Z3EfxnqGTaSmH-cZ8QsKyu0hoOz61GyA3njs,192
-saviialib/libs/files_client/clients/aiofiles_client.py,sha256=Mu5pSnnEa3dT3GONmt1O-lCQstuQNXHtJHM3D2L6TU8,1107
-saviialib/libs/files_client/clients/csv_client.py,sha256=Rk4QbiKlVKrYxYtxQt-Pmkp9QoB_dNgs5r36JB9hU0o,1478
-saviialib/libs/files_client/files_client.py,sha256=oWfaMLA_Lw91H1_pPirFtFbdJh4abSyZp91qBsAiePs,950
-saviialib/libs/files_client/files_client_contract.py,sha256=fYvd68IMpc1OFkxbzNSmRUoTWVctf3hkNVQ7QZV0m6I,304
-saviialib/libs/files_client/types/files_client_types.py,sha256=GOTM5fBY304-EX6IiUnWmt2JpsyQ6Nmb_Tp0wingt0M,755
-saviialib/libs/ftp_client/__init__.py,sha256=dW2Yutgc7mJJJzgKLhWKXMgQ6KIWJYfFa1sGpjHH5xU,191
-saviialib/libs/ftp_client/clients/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-saviialib/libs/ftp_client/clients/aioftp_client.py,sha256=5sgr3PMETgaBRlKeu_avxHIh6tr1gb7t2mkxmpRas_k,1925
-saviialib/libs/ftp_client/clients/ftplib_client.py,sha256=VcpAn23r03iyCUAj35xHU_AVNrll_45uHFN8Z9OnBkE,2203
-saviialib/libs/ftp_client/ftp_client.py,sha256=Naj9p0yYWlXt9um0zKfvuHSoycM8JZg2SPBm8110pYk,1008
-saviialib/libs/ftp_client/ftp_client_contract.py,sha256=tymkugDzsJ5PzUXIaSkwX1h7T0naR15qAkjrqswqDyM,338
-saviialib/libs/ftp_client/types/__init__.py,sha256=syfwf9feP4QK7fkCTfl4j8l11ic-jHtfi1DE2chaWbs,155
-saviialib/libs/ftp_client/types/ftp_client_types.py,sha256=e4SmYkewldulaD8ms2q75zVgLFXyBxBqoa_L-IQOmso,256
-saviialib/libs/sharepoint_client/__init__.py,sha256=6RbEzFtCfMrrY8F0JOCVcK6Gqt1FBJ09m0NuWHMCmCI,384
-saviialib/libs/sharepoint_client/clients/sharepoint_rest_api.py,sha256=Gq__zrYtSyiwi5NguMYCqJ5Bbs84UqzC9L5qvOMhfVI,6100
-saviialib/libs/sharepoint_client/sharepoint_client.py,sha256=gXFisWWCk6pKhoEeaNN8dcHA5ywrGDLqfiKjchrHRy0,1816
-saviialib/libs/sharepoint_client/sharepoint_client_contract.py,sha256=H-WsXR5f50jy5RRYNlgV61y_YGjOUq4U_E1DWUUrDYw,612
-saviialib/libs/sharepoint_client/types/sharepoint_client_types.py,sha256=JruUCn6o16w00t4zxDrxmv_Bxa52UyShGYmwUFfBCCQ,482
-saviialib/libs/zero_dependency/utils/datetime_utils.py,sha256=c2H_JpUKpunCzDw6I4alDWNftEqaciWGtEUklPepm_s,759
-saviialib/services/epii/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-saviialib/services/epii/api.py,sha256=99G-iC8Nz8vv9TuNPpdFsHxDAH8DXVCHnUQzwAUO9Ao,4036
-saviialib/services/epii/controllers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-saviialib/services/epii/controllers/types/__init__.py,sha256=xzky-oTSojLNkWETp_k8a4dcXYvYSQY0VhWo23Yhb8U,195
-saviialib/services/epii/controllers/types/update_thies_data_types.py,sha256=kmt18vq7RLEAfIJj9MYz62fJH9etuU1WqZJ5MYmjiIg,448
-saviialib/services/epii/controllers/types/upload_backup_to_sharepoint_types.py,sha256=5mDMLy3J5grACl1ezBGYZPOyhIkWYeIWWBOklaP2IlQ,471
-saviialib/services/epii/controllers/update_thies_data.py,sha256=8TV420d4VWTvCW18M6sAguHZrX5VODXscgrUfhwO1fs,4884
-saviialib/services/epii/controllers/upload_backup_to_sharepoint.py,sha256=7-ABo89yXhrWv-iOFjCkBGX-y_I62eFaOi1LtO5Gb4k,3817
-saviialib/services/epii/use_cases/components/create_thies_statistics_file.py,sha256=G9K5UpsUYPM_w2sbusiyRWnZwbumSh5rYgil-rt8EB8,5171
-saviialib/services/epii/use_cases/components/thies_bp.py,sha256=1Iq5Wz3kqzJfQNawV_v8ORr_Pl-PoamFp_2Xo8DjvmI,15042
-saviialib/services/epii/use_cases/constants/upload_backup_to_sharepoint_constants.py,sha256=erkn-3E8YwBMFs25o7exXoK7s73NdgP9IYDXeWzALcI,98
-saviialib/services/epii/use_cases/types/__init__.py,sha256=u6fyodOEJE2j6FMqJux40Xf9ccYAi-UUYxqT-Kzc0kE,199
-saviialib/services/epii/use_cases/types/update_thies_data_types.py,sha256=3lJzG1nuZoP1mqFlvQ0-aFJp80SECaeiROlvucVhaSY,539
-saviialib/services/epii/use_cases/types/upload_backup_to_sharepoint_types.py,sha256=J_sGhqSaPoMZA0GIrzCx6pmgSKgIkGi0uyrsltU_H8w,320
-saviialib/services/epii/use_cases/update_thies_data.py,sha256=moB4fz_aOiKBqQixjm5uS0hyvpF9ufLIMWbVxwXqICc,14591
-saviialib/services/epii/use_cases/upload_backup_to_sharepoint.py,sha256=-0MvCzkFM7T2y7XLgFevWAXmqAsthzuY68ReiiL2zDU,11886
-saviialib/services/epii/utils/__init__.py,sha256=cYt2tvq65_OMjFaqb8-CCC7IGCQgFd4ziEUWJV7s1iY,98
-saviialib/services/epii/utils/update_thies_data_utils.py,sha256=EpjYWXqyHxJ-dO3MHhdXp-rGV7WyUckeFko-nnfnNac,555
-saviialib/services/epii/utils/upload_backup_to_sharepoint_utils.py,sha256=hEeV4_kcG8YL6t_3V8AlhgDHtHiUNsdYpilfgTLaQMc,3528
-saviialib-1.3.0.dist-info/LICENSE,sha256=NWpf6b38xgBWPBo5HZsCbdfp9hZSliEbRqWQgm0fkOo,1076
-saviialib-1.3.0.dist-info/METADATA,sha256=-qovhCVP7ZvvgeEKiFLSEo2OhlcVselpsLdvW82umIc,4113
-saviialib-1.3.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-saviialib-1.3.0.dist-info/RECORD,,