funapi-sciencedb 1.0.1__tar.gz

funapi_sciencedb-1.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 farfarfun
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

funapi_sciencedb-1.0.1/PKG-INFO

@@ -0,0 +1,10 @@
+Metadata-Version: 2.1
+Name: funapi-sciencedb
+Version: 1.0.1
+Summary: Add your description here
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: funutil>=1.0.42
+
+# funapi-sciencedb

funapi_sciencedb-1.0.1/README.md

@@ -0,0 +1 @@
+# funapi-sciencedb

funapi_sciencedb-1.0.1/pyproject.toml

@@ -0,0 +1,7 @@
+[project]
+name = "funapi-sciencedb"
+version = "1.0.1"
+description = "Add your description here"
+readme = "README.md"
+requires-python = ">=3.8"
+dependencies = [ "funutil>=1.0.42",]

funapi_sciencedb-1.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

funapi_sciencedb-1.0.1/src/funapi_sciencedb.egg-info/PKG-INFO

@@ -0,0 +1,10 @@
+Metadata-Version: 2.1
+Name: funapi-sciencedb
+Version: 1.0.1
+Summary: Add your description here
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: funutil>=1.0.42
+
+# funapi-sciencedb

funapi_sciencedb-1.0.1/src/funapi_sciencedb.egg-info/SOURCES.txt

@@ -0,0 +1,57 @@
+LICENSE
+README.md
+pyproject.toml
+src/funapi_sciencedb.egg-info/PKG-INFO
+src/funapi_sciencedb.egg-info/SOURCES.txt
+src/funapi_sciencedb.egg-info/dependency_links.txt
+src/funapi_sciencedb.egg-info/requires.txt
+src/funapi_sciencedb.egg-info/top_level.txt
+src/sciencedb/__init__.py
+src/sciencedb/client.py
+src/sciencedb/errors.py
+src/sciencedb/types.py
+src/sciencedb/api/__init__.py
+src/sciencedb/api/open_api_controller/__init__.py
+src/sciencedb/api/open_api_controller/harvest_using_get.py
+src/sciencedb/api/open_api_controller/json_using_get.py
+src/sciencedb/api/open_api_controller/metrics_using_get.py
+src/sciencedb/api/open_api_controller/search_using_get.py
+src/sciencedb/api/sushi_controller/__init__.py
+src/sciencedb/api/sushi_controller/get_api_status.py
+src/sciencedb/api/sushi_controller/get_report_by_id_using_get.py
+src/sciencedb/api/sushi_controller/get_reports.py
+src/sciencedb/models/__init__.py
+src/sciencedb/models/api_result_metrics_result.py
+src/sciencedb/models/api_result_search_result.py
+src/sciencedb/models/counter_dataset_attributes.py
+src/sciencedb/models/counter_dataset_attributes_type.py
+src/sciencedb/models/counter_dataset_contributors.py
+src/sciencedb/models/counter_dataset_contributors_type.py
+src/sciencedb/models/counter_dataset_dates.py
+src/sciencedb/models/counter_dataset_dates_type.py
+src/sciencedb/models/counter_dataset_identifiers.py
+src/sciencedb/models/counter_dataset_identifiers_type.py
+src/sciencedb/models/counter_dataset_instance.py
+src/sciencedb/models/counter_dataset_instance_access_method.py
+src/sciencedb/models/counter_dataset_instance_metric_type.py
+src/sciencedb/models/counter_dataset_performance.py
+src/sciencedb/models/counter_dataset_period.py
+src/sciencedb/models/counter_dataset_report.py
+src/sciencedb/models/counter_dataset_usage.py
+src/sciencedb/models/counter_dataset_usage_data_type.py
+src/sciencedb/models/counter_publisher_identifiers.py
+src/sciencedb/models/counter_publisher_identifiers_type.py
+src/sciencedb/models/metrics_result.py
+src/sciencedb/models/search_record.py
+src/sciencedb/models/search_result.py
+src/sciencedb/models/sushi_error_model.py
+src/sciencedb/models/sushi_error_model_severity.py
+src/sciencedb/models/sushi_page_meta.py
+src/sciencedb/models/sushi_report.py
+src/sciencedb/models/sushi_report_header.py
+src/sciencedb/models/sushi_report_header_report_attributes_item.py
+src/sciencedb/models/sushi_report_header_report_filters_item.py
+src/sciencedb/models/sushi_report_list.py
+src/sciencedb/models/sushi_report_page.py
+src/sciencedb/models/sushi_service_status.py
+src/sciencedb/models/sushi_service_status_alerts_item.py

funapi_sciencedb-1.0.1/src/funapi_sciencedb.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

funapi_sciencedb-1.0.1/src/funapi_sciencedb.egg-info/requires.txt

@@ -0,0 +1 @@
+funutil>=1.0.42

funapi_sciencedb-1.0.1/src/funapi_sciencedb.egg-info/top_level.txt

@@ -0,0 +1 @@
+sciencedb

funapi_sciencedb-1.0.1/src/sciencedb/__init__.py

@@ -0,0 +1,8 @@
+"""A client library for accessing ScienceDB API Doc"""
+
+from .client import AuthenticatedClient, Client
+
+__all__ = (
+    "AuthenticatedClient",
+    "Client",
+)

funapi_sciencedb-1.0.1/src/sciencedb/api/__init__.py

@@ -0,0 +1 @@
+"""Contains methods for accessing the API"""

funapi_sciencedb-1.0.1/src/sciencedb/api/open_api_controller/harvest_using_get.py

@@ -0,0 +1,211 @@
+from http import HTTPStatus
+from typing import Any, Dict, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.api_result_search_result import APIResultSearchResult
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    *,
+    end_time: Union[Unset, str] = "2099-01-01",
+    page: Union[Unset, int] = 1,
+    size: Union[Unset, int] = 10,
+    start_time: Union[Unset, str] = "1970-01-01",
+) -> Dict[str, Any]:
+    params: Dict[str, Any] = {}
+
+    params["end_time"] = end_time
+
+    params["page"] = page
+
+    params["size"] = size
+
+    params["start_time"] = start_time
+
+    params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
+
+    _kwargs: Dict[str, Any] = {
+        "method": "get",
+        "url": "/harvest",
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[APIResultSearchResult]:
+    if response.status_code == 200:
+        response_200 = APIResultSearchResult.from_dict(response.json())
+
+        return response_200
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Response[APIResultSearchResult]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    end_time: Union[Unset, str] = "2099-01-01",
+    page: Union[Unset, int] = 1,
+    size: Union[Unset, int] = 10,
+    start_time: Union[Unset, str] = "1970-01-01",
+) -> Response[APIResultSearchResult]:
+    """harvest dataset by dataset's publish time period(start_time and end_time)
+
+     result is order by publish time desc
+
+    Args:
+        end_time (Union[Unset, str]):  Default: '2099-01-01'.
+        page (Union[Unset, int]):  Default: 1.
+        size (Union[Unset, int]):  Default: 10.
+        start_time (Union[Unset, str]):  Default: '1970-01-01'.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[APIResultSearchResult]
+    """
+
+    kwargs = _get_kwargs(
+        end_time=end_time,
+        page=page,
+        size=size,
+        start_time=start_time,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    end_time: Union[Unset, str] = "2099-01-01",
+    page: Union[Unset, int] = 1,
+    size: Union[Unset, int] = 10,
+    start_time: Union[Unset, str] = "1970-01-01",
+) -> Optional[APIResultSearchResult]:
+    """harvest dataset by dataset's publish time period(start_time and end_time)
+
+     result is order by publish time desc
+
+    Args:
+        end_time (Union[Unset, str]):  Default: '2099-01-01'.
+        page (Union[Unset, int]):  Default: 1.
+        size (Union[Unset, int]):  Default: 10.
+        start_time (Union[Unset, str]):  Default: '1970-01-01'.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        APIResultSearchResult
+    """
+
+    return sync_detailed(
+        client=client,
+        end_time=end_time,
+        page=page,
+        size=size,
+        start_time=start_time,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    end_time: Union[Unset, str] = "2099-01-01",
+    page: Union[Unset, int] = 1,
+    size: Union[Unset, int] = 10,
+    start_time: Union[Unset, str] = "1970-01-01",
+) -> Response[APIResultSearchResult]:
+    """harvest dataset by dataset's publish time period(start_time and end_time)
+
+     result is order by publish time desc
+
+    Args:
+        end_time (Union[Unset, str]):  Default: '2099-01-01'.
+        page (Union[Unset, int]):  Default: 1.
+        size (Union[Unset, int]):  Default: 10.
+        start_time (Union[Unset, str]):  Default: '1970-01-01'.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[APIResultSearchResult]
+    """
+
+    kwargs = _get_kwargs(
+        end_time=end_time,
+        page=page,
+        size=size,
+        start_time=start_time,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    end_time: Union[Unset, str] = "2099-01-01",
+    page: Union[Unset, int] = 1,
+    size: Union[Unset, int] = 10,
+    start_time: Union[Unset, str] = "1970-01-01",
+) -> Optional[APIResultSearchResult]:
+    """harvest dataset by dataset's publish time period(start_time and end_time)
+
+     result is order by publish time desc
+
+    Args:
+        end_time (Union[Unset, str]):  Default: '2099-01-01'.
+        page (Union[Unset, int]):  Default: 1.
+        size (Union[Unset, int]):  Default: 10.
+        start_time (Union[Unset, str]):  Default: '1970-01-01'.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        APIResultSearchResult
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            end_time=end_time,
+            page=page,
+            size=size,
+            start_time=start_time,
+        )
+    ).parsed

funapi_sciencedb-1.0.1/src/sciencedb/api/open_api_controller/json_using_get.py

@@ -0,0 +1,164 @@
+from http import HTTPStatus
+from typing import Any, Dict, Optional, Union, cast
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...types import UNSET, Response
+
+
+def _get_kwargs(
+    *,
+    doi: str,
+) -> Dict[str, Any]:
+    params: Dict[str, Any] = {}
+
+    params["doi"] = doi
+
+    params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
+
+    _kwargs: Dict[str, Any] = {
+        "method": "get",
+        "url": "/json",
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[str]:
+    if response.status_code == 200:
+        response_200 = cast(str, response.json())
+        return response_200
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Response[str]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    doi: str,
+) -> Response[str]:
+    """get dataset's detail information by it's doi
+
+     information's format is referenced by https://schema.org/Dataset
+
+    Args:
+        doi (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[str]
+    """
+
+    kwargs = _get_kwargs(
+        doi=doi,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    doi: str,
+) -> Optional[str]:
+    """get dataset's detail information by it's doi
+
+     information's format is referenced by https://schema.org/Dataset
+
+    Args:
+        doi (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        str
+    """
+
+    return sync_detailed(
+        client=client,
+        doi=doi,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    doi: str,
+) -> Response[str]:
+    """get dataset's detail information by it's doi
+
+     information's format is referenced by https://schema.org/Dataset
+
+    Args:
+        doi (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[str]
+    """
+
+    kwargs = _get_kwargs(
+        doi=doi,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    doi: str,
+) -> Optional[str]:
+    """get dataset's detail information by it's doi
+
+     information's format is referenced by https://schema.org/Dataset
+
+    Args:
+        doi (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        str
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            doi=doi,
+        )
+    ).parsed

funapi_sciencedb-1.0.1/src/sciencedb/api/open_api_controller/metrics_using_get.py

@@ -0,0 +1,166 @@
+from http import HTTPStatus
+from typing import Any, Dict, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.api_result_metrics_result import APIResultMetricsResult
+from ...types import UNSET, Response
+
+
+def _get_kwargs(
+    *,
+    doi: str,
+) -> Dict[str, Any]:
+    params: Dict[str, Any] = {}
+
+    params["doi"] = doi
+
+    params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
+
+    _kwargs: Dict[str, Any] = {
+        "method": "get",
+        "url": "/metrics",
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[APIResultMetricsResult]:
+    if response.status_code == 200:
+        response_200 = APIResultMetricsResult.from_dict(response.json())
+
+        return response_200
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Response[APIResultMetricsResult]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    doi: str,
+) -> Response[APIResultMetricsResult]:
+    """search dataset metrics by doi
+
+     search dataset metrics by doi
+
+    Args:
+        doi (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[APIResultMetricsResult]
+    """
+
+    kwargs = _get_kwargs(
+        doi=doi,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    doi: str,
+) -> Optional[APIResultMetricsResult]:
+    """search dataset metrics by doi
+
+     search dataset metrics by doi
+
+    Args:
+        doi (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        APIResultMetricsResult
+    """
+
+    return sync_detailed(
+        client=client,
+        doi=doi,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    doi: str,
+) -> Response[APIResultMetricsResult]:
+    """search dataset metrics by doi
+
+     search dataset metrics by doi
+
+    Args:
+        doi (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[APIResultMetricsResult]
+    """
+
+    kwargs = _get_kwargs(
+        doi=doi,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    doi: str,
+) -> Optional[APIResultMetricsResult]:
+    """search dataset metrics by doi
+
+     search dataset metrics by doi
+
+    Args:
+        doi (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        APIResultMetricsResult
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            doi=doi,
+        )
+    ).parsed