cloudnet-api-client 0.10.0__tar.gz → 0.12.0__tar.gz

{cloudnet_api_client-0.10.0 → cloudnet_api_client-0.12.0}/.github/workflows/test.yml

@@ -1,4 +1,4 @@
-name: Test against dataportal backend
+name: Test and lint
 
 on: [push, pull_request]
 

{cloudnet_api_client-0.10.0 → cloudnet_api_client-0.12.0}/CHANGELOG.md

@@ -5,6 +5,15 @@ 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.12.0 – 2025-08-25
+
+- Adjust routes and responses
+
+## 0.11.0 – 2025-08-16
+
+- Adjust routes and responses
+- Improve tests
+
 ## 0.10.0 – 2025-08-13
 
 - Add `volatile` to metadata response

{cloudnet_api_client-0.10.0 → cloudnet_api_client-0.12.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cloudnet-api-client
-Version: 0.10.0
+Version: 0.12.0
 Summary: Cloudnet API client
 Author-email: Simo Tukiainen <simo.tukiainen@fmi.fi>
 License-File: LICENSE
@@ -22,7 +22,9 @@ Requires-Dist: types-requests; extra == 'dev'
 Requires-Dist: types-tqdm; extra == 'dev'
 Provides-Extra: test
 Requires-Dist: mypy; extra == 'test'
+Requires-Dist: netcdf4; extra == 'test'
 Requires-Dist: pytest; extra == 'test'
+Requires-Dist: pytest-asyncio; extra == 'test'
 Description-Content-Type: text/markdown
 
 [![CI](https://github.com/actris-cloudnet/cloudnet-api-client/actions/workflows/test.yml/badge.svg)](https://github.com/actris-cloudnet/cloudnet-api-client/actions/workflows/test.yml)
@@ -45,14 +47,25 @@ from cloudnet_api_client import APIClient
 
 client = APIClient()
 
-sites = client.sites(type="cloudnet")
+sites = client.sites()
+site = client.site("hyytiala")
+
 products = client.products()
+product = client.products("classification")
+
+models = client.models()
+model = client.model("ecmwf-open")
+
+instruments = client.instruments()
+instrument = client.instrument("d6bf209b-c48b-48a4-bbfb-fed713b27832")
 
-metadata = client.metadata(site_id="hyytiala", date="2021-01-01", product=["mwr", "radar"])
-file_paths = client.download(metadata, "data/")
+file = client.file("405cc410-1f24-4ea9-bae8-da7f22be26cb")
 
-raw_metadata = client.raw_metadata(site_id="granada", date="2024-01", instrument_id="parsivel")
-file_paths = client.download(raw_metadata, "data_raw/")
+files = client.files(site_id="hyytiala", date="2021-01-01", product_id=["mwr", "radar"])
+file_paths = client.download(files, "data/")
+
+raw_files = client.raw_files(site_id="granada", date="2024-01", instrument_id="parsivel")
+file_paths = client.download(raw_files, "data_raw/")
 ```
 
 When downloading files inside Jupyter notebook (or similar environment), you have to use the asynchronous version:
@@ -63,7 +76,7 @@ file_paths = await client.adownload(metadata)
 
 ## Documentation
 
-### `APIClient().metadata()` and `raw_metadata()` &rarr; `list[Metadata]`
+### `APIClient().files()` and `raw_files()` &rarr; `list[Metadata]`
 
 Fetch product and raw file metadata from the Cloudnet data portal.
 
@@ -81,15 +94,15 @@ Parameters:
 | instrument_id       | `str` or `list[str]`        | `None`  | "rpg-fmcw-94"                                        |
 | instrument_pid      | `str` or `list[str]`        | `None`  | "https://hdl.handle.net/21.12132/3.191564170f8a4686" |
 | model_id            | `str` or `list[str]`        | `None`  | "gdas1"                                              |
-| product\*           | `str` or `list[str]`        | `None`  | "classification"                                     |
+| product_id\*        | `str` or `list[str]`        | `None`  | "classification"                                     |
 | show_legacy\*       | `bool`                      | `False` |                                                      |
 | filename_prefix\*\* | `str` or `list[str]`        | `None`  | "stare"                                              |
 | filename_suffix\*\* | `str` or `list[str]`        | `None`  | ".lv1"                                               |
 | status\*\*          | `str` or `list[str]`        | `None`  | "created", "uploaded", "processed" or "invalid"      |
 
-\* = only in `metadata()`
+\* = only in `files()`
 
-\*\* = only in `raw_metadata()`
+\*\* = only in `raw_files()`
 
 **Date Handling**
 
@@ -128,30 +141,93 @@ Parameters:
 
 \* = only with `RawMetadata`
 
+### `APIClient().file()` &rarr; `ProductMetadata`
+
+Fetch metadata of a single file.
+
+Parameters:
+
+| name | type                 |
+| ---- | -------------------- |
+| uuid | `str` or `uuid.UUID` |
+
 ### `APIClient().sites()` &rarr; `list[Site]`
 
-Fetch cloudnet sites.
+Fetch all sites.
 
 Parameters:
 
-| name    | type                 | Choices                                   | default |
-| ------- | -------------------- | ----------------------------------------- | ------- |
-| site_id | `str`                |                                           | `None`  |
-| type    | `str` or `list[str]` | "cloudnet", "campaign", "model", "hidden" | `None`  |
+| name | type  | choices                                   | default |
+| ---- | ----- | ----------------------------------------- | ------- |
+| type | `str` | "cloudnet", "campaign", "model", "hidden" | `None`  |
+
+### `APIClient().site()` &rarr; `Site`
+
+Fetch a single site.
+
+Parameters:
+
+| name    | type  |
+| ------- | ----- |
+| site_id | `str` |
 
 ### `APIClient().products()` &rarr; `list[Product]`
 
-Fetch cloudnet products.
+Fetch all products.
 
 Parameters:
 
-| name | type                 | Choices                                   | default |
+| name | type                 | choices                                   | default |
 | ---- | -------------------- | ----------------------------------------- | ------- |
 | type | `str` or `list[str]` | "instrument", "geophysical", "evaluation" | `None`  |
 
+### `APIClient().product()` &rarr; `ExtendedProduct`
+
+Fetch a single product.
+
+Parameters:
+
+| name       | type  |
+| ---------- | ----- |
+| product_id | `str` |
+
 ### `APIClient().instruments()` &rarr; `list[Instrument]`
 
-Fetch cloudnet instruments.
+Fetch all instruments.
+
+### `APIClient().instrument()` &rarr; `ExtendedInstrument`
+
+Fetch a single instruments.
+
+Parameters:
+
+| name | type  |
+| ---- | ----- |
+| uuid | `str` |
+
+### `APIClient().models()` &rarr; `list[Model]`
+
+Fetch all models.
+
+### `APIClient().instrument()` &rarr; `Model`
+
+Fetch a single model.
+
+Parameters:
+
+| name     | type  |
+| -------- | ----- |
+| model_id | `str` |
+
+### `APIClient().versions()` &rarr; `list[VersionMetadata]`
+
+Fetch information of all versions of a file.
+
+Parameters:
+
+| name | type                 |
+| ---- | -------------------- |
+| uuid | `str` or `uuid.UUID` |
 
 ### `APIClient().download(list[Metadata])` &rarr; `list[Path]`
 

{cloudnet_api_client-0.10.0 → cloudnet_api_client-0.12.0}/README.md

@@ -18,14 +18,25 @@ from cloudnet_api_client import APIClient
 
 client = APIClient()
 
-sites = client.sites(type="cloudnet")
+sites = client.sites()
+site = client.site("hyytiala")
+
 products = client.products()
+product = client.products("classification")
+
+models = client.models()
+model = client.model("ecmwf-open")
+
+instruments = client.instruments()
+instrument = client.instrument("d6bf209b-c48b-48a4-bbfb-fed713b27832")
 
-metadata = client.metadata(site_id="hyytiala", date="2021-01-01", product=["mwr", "radar"])
-file_paths = client.download(metadata, "data/")
+file = client.file("405cc410-1f24-4ea9-bae8-da7f22be26cb")
 
-raw_metadata = client.raw_metadata(site_id="granada", date="2024-01", instrument_id="parsivel")
-file_paths = client.download(raw_metadata, "data_raw/")
+files = client.files(site_id="hyytiala", date="2021-01-01", product_id=["mwr", "radar"])
+file_paths = client.download(files, "data/")
+
+raw_files = client.raw_files(site_id="granada", date="2024-01", instrument_id="parsivel")
+file_paths = client.download(raw_files, "data_raw/")
 ```
 
 When downloading files inside Jupyter notebook (or similar environment), you have to use the asynchronous version:
@@ -36,7 +47,7 @@ file_paths = await client.adownload(metadata)
 
 ## Documentation
 
-### `APIClient().metadata()` and `raw_metadata()` → `list[Metadata]`
+### `APIClient().files()` and `raw_files()` → `list[Metadata]`
 
 Fetch product and raw file metadata from the Cloudnet data portal.
 
@@ -54,15 +65,15 @@ Parameters:
 | instrument_id       | `str` or `list[str]`        | `None`  | "rpg-fmcw-94"                                        |
 | instrument_pid      | `str` or `list[str]`        | `None`  | "https://hdl.handle.net/21.12132/3.191564170f8a4686" |
 | model_id            | `str` or `list[str]`        | `None`  | "gdas1"                                              |
-| product\*           | `str` or `list[str]`        | `None`  | "classification"                                     |
+| product_id\*        | `str` or `list[str]`        | `None`  | "classification"                                     |
 | show_legacy\*       | `bool`                      | `False` |                                                      |
 | filename_prefix\*\* | `str` or `list[str]`        | `None`  | "stare"                                              |
 | filename_suffix\*\* | `str` or `list[str]`        | `None`  | ".lv1"                                               |
 | status\*\*          | `str` or `list[str]`        | `None`  | "created", "uploaded", "processed" or "invalid"      |
 
-\* = only in `metadata()`
+\* = only in `files()`
 
-\*\* = only in `raw_metadata()`
+\*\* = only in `raw_files()`
 
 **Date Handling**
 
@@ -101,30 +112,93 @@ Parameters:
 
 \* = only with `RawMetadata`
 
+### `APIClient().file()` → `ProductMetadata`
+
+Fetch metadata of a single file.
+
+Parameters:
+
+| name | type                 |
+| ---- | -------------------- |
+| uuid | `str` or `uuid.UUID` |
+
 ### `APIClient().sites()` → `list[Site]`
 
-Fetch cloudnet sites.
+Fetch all sites.
 
 Parameters:
 
-| name    | type                 | Choices                                   | default |
-| ------- | -------------------- | ----------------------------------------- | ------- |
-| site_id | `str`                |                                           | `None`  |
-| type    | `str` or `list[str]` | "cloudnet", "campaign", "model", "hidden" | `None`  |
+| name | type  | choices                                   | default |
+| ---- | ----- | ----------------------------------------- | ------- |
+| type | `str` | "cloudnet", "campaign", "model", "hidden" | `None`  |
+
+### `APIClient().site()` → `Site`
+
+Fetch a single site.
+
+Parameters:
+
+| name    | type  |
+| ------- | ----- |
+| site_id | `str` |
 
 ### `APIClient().products()` → `list[Product]`
 
-Fetch cloudnet products.
+Fetch all products.
 
 Parameters:
 
-| name | type                 | Choices                                   | default |
+| name | type                 | choices                                   | default |
 | ---- | -------------------- | ----------------------------------------- | ------- |
 | type | `str` or `list[str]` | "instrument", "geophysical", "evaluation" | `None`  |
 
+### `APIClient().product()` → `ExtendedProduct`
+
+Fetch a single product.
+
+Parameters:
+
+| name       | type  |
+| ---------- | ----- |
+| product_id | `str` |
+
 ### `APIClient().instruments()` → `list[Instrument]`
 
-Fetch cloudnet instruments.
+Fetch all instruments.
+
+### `APIClient().instrument()` → `ExtendedInstrument`
+
+Fetch a single instruments.
+
+Parameters:
+
+| name | type  |
+| ---- | ----- |
+| uuid | `str` |
+
+### `APIClient().models()` → `list[Model]`
+
+Fetch all models.
+
+### `APIClient().instrument()` → `Model`
+
+Fetch a single model.
+
+Parameters:
+
+| name     | type  |
+| -------- | ----- |
+| model_id | `str` |
+
+### `APIClient().versions()` → `list[VersionMetadata]`
+
+Fetch information of all versions of a file.
+
+Parameters:
+
+| name | type                 |
+| ---- | -------------------- |
+| uuid | `str` or `uuid.UUID` |
 
 ### `APIClient().download(list[Metadata])` → `list[Path]`
 

cloudnet_api_client-0.12.0/cloudnet_api_client/__init__.py

@@ -0,0 +1,2 @@
+from .client import APIClient as APIClient
+from .utils import CloudnetAPIError as CloudnetAPIError