cloudnet-api-client 0.8.0__tar.gz → 0.9.0__tar.gz

{cloudnet_api_client-0.8.0 → cloudnet_api_client-0.9.0}/CHANGELOG.md

@@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 0.9.0 – 2025-05-14
+
+- By default download to current folder
+
 ## 0.8.0 – 2025-05-14
 
 - Add site to metadata responses

{cloudnet_api_client-0.8.0 → cloudnet_api_client-0.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cloudnet-api-client
-Version: 0.8.0
+Version: 0.9.0
 Summary: Cloudnet API client
 Author-email: Simo Tukiainen <simo.tukiainen@fmi.fi>
 License-File: LICENSE
@@ -48,11 +48,17 @@ client = APIClient()
 sites = client.sites(type="cloudnet")
 products = client.products()
 
-metadata = client.metadata("hyytiala", "2021-01-01", product=["mwr", "radar"])
-client.download(metadata, "data/")
+metadata = client.metadata(site_id="hyytiala", date="2021-01-01", product=["mwr", "radar"])
+file_paths = client.download(metadata, "data/")
 
-raw_metadata = client.raw_metadata("granada", date="2024-01", instrument_id="parsivel")
-client.download(raw_metadata, "data_raw/")
+raw_metadata = client.raw_metadata(site_id="granada", date="2024-01", instrument_id="parsivel")
+file_paths = client.download(raw_metadata, "data_raw/")
+```
+
+When downloading files inside Jupyter notebook (or similar environment), you have to use the asynchronous version:
+
+```python
+file_paths = await client.adownload(metadata)
 ```
 
 ## Documentation
@@ -152,13 +158,13 @@ Download files from the fetched metadata.
 
 Parameters:
 
-| name              | type                                           | default |
-| ----------------- | ---------------------------------------------- | ------- |
-| metadata          | `list[RawMetadata]` or `list[ProductMetadata]` |         |
-| output_directory  | `PathLike` or `str`                            |         |
-| concurrency_limit | `int`                                          | 5       |
-| progress          | `bool` or `None`                               | `None`  |
-| validate_checksum | `bool`                                         | `False` |
+| name              | type                                           | default           |
+| ----------------- | ---------------------------------------------- | ----------------- |
+| metadata          | `list[RawMetadata]` or `list[ProductMetadata]` |                   |
+| output_directory  | `PathLike` or `str`                            | Current directory |
+| concurrency_limit | `int`                                          | 5                 |
+| progress          | `bool` or `None`                               | `None`            |
+| validate_checksum | `bool`                                         | `False`           |
 
 There's also an asynchronous version of this function:
 `cloudnet_api_client.adownload`. It's useful for usage inside Jupyter notebook.

{cloudnet_api_client-0.8.0 → cloudnet_api_client-0.9.0}/README.md

@@ -21,11 +21,17 @@ client = APIClient()
 sites = client.sites(type="cloudnet")
 products = client.products()
 
-metadata = client.metadata("hyytiala", "2021-01-01", product=["mwr", "radar"])
-client.download(metadata, "data/")
+metadata = client.metadata(site_id="hyytiala", date="2021-01-01", product=["mwr", "radar"])
+file_paths = client.download(metadata, "data/")
 
-raw_metadata = client.raw_metadata("granada", date="2024-01", instrument_id="parsivel")
-client.download(raw_metadata, "data_raw/")
+raw_metadata = client.raw_metadata(site_id="granada", date="2024-01", instrument_id="parsivel")
+file_paths = client.download(raw_metadata, "data_raw/")
+```
+
+When downloading files inside Jupyter notebook (or similar environment), you have to use the asynchronous version:
+
+```python
+file_paths = await client.adownload(metadata)
 ```
 
 ## Documentation
@@ -125,13 +131,13 @@ Download files from the fetched metadata.
 
 Parameters:
 
-| name              | type                                           | default |
-| ----------------- | ---------------------------------------------- | ------- |
-| metadata          | `list[RawMetadata]` or `list[ProductMetadata]` |         |
-| output_directory  | `PathLike` or `str`                            |         |
-| concurrency_limit | `int`                                          | 5       |
-| progress          | `bool` or `None`                               | `None`  |
-| validate_checksum | `bool`                                         | `False` |
+| name              | type                                           | default           |
+| ----------------- | ---------------------------------------------- | ----------------- |
+| metadata          | `list[RawMetadata]` or `list[ProductMetadata]` |                   |
+| output_directory  | `PathLike` or `str`                            | Current directory |
+| concurrency_limit | `int`                                          | 5                 |
+| progress          | `bool` or `None`                               | `None`            |
+| validate_checksum | `bool`                                         | `False`           |
 
 There's also an asynchronous version of this function:
 `cloudnet_api_client.adownload`. It's useful for usage inside Jupyter notebook.

{cloudnet_api_client-0.8.0 → cloudnet_api_client-0.9.0}/cloudnet_api_client/client.py

@@ -193,7 +193,7 @@ class APIClient:
     def download(
         self,
         metadata: MetadataList,
-        output_directory: str | PathLike,
+        output_directory: str | PathLike = ".",
         concurrency_limit: int = 5,
         progress: bool | None = None,
         validate_checksum: bool = False,
@@ -211,7 +211,7 @@ class APIClient:
     async def adownload(
         self,
         metadata: MetadataList,
-        output_directory: str | PathLike,
+        output_directory: str | PathLike = ".",
         concurrency_limit: int = 5,
         progress: bool | None = None,
         validate_checksum: bool = False,

cloudnet_api_client-0.9.0/cloudnet_api_client/version.py

@@ -0,0 +1 @@
+__version__ = "0.9.0"

cloudnet_api_client-0.8.0/cloudnet_api_client/version.py

@@ -1 +0,0 @@
-__version__ = "0.8.0"