datagovmy-python-sdk 1.0.1__py3-none-any.whl

datagovmy/__init__.py

@@ -0,0 +1,3 @@
+from datagovmy.datagovmy import DataGovMyClient
+
+__all__ = ["DataGovMyClient"]

datagovmy/core/api.py

@@ -0,0 +1,76 @@
+import logging
+from typing import Any, Optional, cast
+
+import requests
+from requests.adapters import HTTPAdapter
+from urllib3.util.retry import Retry
+
+logger = logging.getLogger(__name__)
+
+
+class BaseAPIClient:
+    """Generic API client with configurable retry support.
+
+    Args:
+        base_url: Base URL for all requests (e.g. "https://api.example.com").
+        headers: Default headers sent with every request.
+        retry_strategy: A ``urllib3.util.retry.Retry`` instance that controls
+            which status codes trigger retries, how many times, and the backoff.
+    """
+
+    def __init__(
+        self,
+        base_url: str,
+        headers: Optional[dict[str, str]] = None,
+        retry_strategy: Optional[Retry] = None,
+    ):
+        self.base_url = base_url
+        self.session = requests.Session()
+        if headers:
+            self.session.headers.update(headers)
+        if retry_strategy:
+            adapter = HTTPAdapter(max_retries=cast(Any, retry_strategy))
+            self.session.mount("http://", adapter)
+            self.session.mount("https://", adapter)
+
+    def _build_url(self, path: str) -> str:
+        return f"{self.base_url}{path}"
+
+    def _request(self, method: str, path: str, **kwargs: Any) -> requests.Response:
+        url = self._build_url(path)
+        logger.debug("Requesting %s %s", method, url)
+        response = self.session.request(method, url, **kwargs)
+        response.raise_for_status()
+        return response
+
+    def get(
+        self,
+        path: str,
+        params: Optional[dict[str, Any]] = None,
+        headers: Optional[dict[str, str]] = None,
+    ) -> requests.Response:
+        return self._request("GET", path, params=params, headers=headers)
+
+    def post(
+        self,
+        path: str,
+        json: Optional[Any] = None,
+        headers: Optional[dict[str, str]] = None,
+    ) -> requests.Response:
+        return self._request("POST", path, json=json, headers=headers)
+
+    def put(
+        self,
+        path: str,
+        json: Optional[Any] = None,
+        headers: Optional[dict[str, str]] = None,
+    ) -> requests.Response:
+        return self._request("PUT", path, json=json, headers=headers)
+
+    def delete(
+        self,
+        path: str,
+        params: Optional[dict[str, Any]] = None,
+        headers: Optional[dict[str, str]] = None,
+    ) -> requests.Response:
+        return self._request("DELETE", path, params=params, headers=headers)

datagovmy/datagovmy.py

@@ -0,0 +1,22 @@
+from typing import Optional
+
+from datagovmy.service import DataCatalogueClient, OpenDOSMClient
+
+
+class DataGovMyClient:
+    def __init__(self, api_key: Optional[str] = None):
+        self.api_key = api_key
+        self._data_catalogue: Optional[DataCatalogueClient] = None
+        self._opendosm: Optional[OpenDOSMClient] = None
+
+    @property
+    def data_catalogue(self) -> DataCatalogueClient:
+        if self._data_catalogue is None:
+            self._data_catalogue = DataCatalogueClient(api_key=self.api_key)
+        return self._data_catalogue
+
+    @property
+    def opendosm(self) -> OpenDOSMClient:
+        if self._opendosm is None:
+            self._opendosm = OpenDOSMClient(api_key=self.api_key)
+        return self._opendosm

datagovmy/service/__init__.py

@@ -0,0 +1,4 @@
+from datagovmy.service.data_catalogue import DataCatalogueClient
+from datagovmy.service.open_dosm import OpenDOSMClient
+
+__all__ = ["DataCatalogueClient", "OpenDOSMClient"]

datagovmy/service/data_catalogue.py

@@ -0,0 +1,23 @@
+from typing import Optional
+
+from datagovmy.core.api import BaseAPIClient
+from datagovmy.service.environment import get_base_url
+
+
+class DataCatalogueClient(BaseAPIClient):
+    ENDPOINT = "/data-catalogue"
+
+    def __init__(self, api_key: Optional[str] = None):
+        super().__init__(base_url=get_base_url())
+        self.api_key = api_key
+
+    def get_dataset_as_json(self, id: str, **kwargs):
+        # kwargs can be used to add additional query parameters for filtering
+        # reference: https://developer.data.gov.my/request-query
+        endpoint = f"{self.ENDPOINT}?id={id}"
+        filters = "&".join(f"{k}={v}" for k, v in kwargs.items())
+
+        if filters:
+            endpoint += f"&{filters}"
+
+        return self.get(endpoint).json()

datagovmy/service/environment.py

@@ -0,0 +1,2 @@
+def get_base_url():
+    return "https://api.data.gov.my"

datagovmy/service/exceptions.py

@@ -0,0 +1,6 @@
+class FatalException(Exception):
+    pass
+
+
+class UnknownServiceException(FatalException):
+    pass

datagovmy/service/open_dosm.py

@@ -0,0 +1,23 @@
+from typing import Optional
+
+from datagovmy.core.api import BaseAPIClient
+from datagovmy.service.environment import get_base_url
+
+
+class OpenDOSMClient(BaseAPIClient):
+    ENDPOINT = "/opendosm"
+
+    def __init__(self, api_key: Optional[str] = None):
+        super().__init__(base_url=get_base_url())
+        self.api_key = api_key
+
+    def get_dataset_as_json(self, id: str, **kwargs):
+        # kwargs can be used to add additional query parameters for filtering
+        # reference: https://developer.data.gov.my/request-query
+        endpoint = f"{self.ENDPOINT}?id={id}"
+        filters = "&".join(f"{k}={v}" for k, v in kwargs.items())
+
+        if filters:
+            endpoint += f"&{filters}"
+
+        return self.get(endpoint).json()

datagovmy_python_sdk-1.0.1.dist-info/METADATA

@@ -0,0 +1,63 @@
+Metadata-Version: 2.4
+Name: datagovmy-python-sdk
+Version: 1.0.1
+Summary: Add your description here
+Requires-Python: >=3.13
+Requires-Dist: requests
+Description-Content-Type: text/markdown
+
+# Data.gov.my Python SDK
+
+Unofficial SDK for accessing open source data on https://data.gov.my.
+
+## Installation
+
+```bash
+pip install mydata
+```
+
+## Quick Start
+
+```python
+from datagovmy import DataGovMyClient
+
+client = DataGovMyClient()
+
+# Fetch a dataset from the national data catalogue
+data = client.data_catalogue.get_dataset_as_json(id="population_malaysia")
+
+# Fetch with filters
+data = client.data_catalogue.get_dataset_as_json(
+    id="population_malaysia",
+    filter="Selangor@location",
+    sort="-year",
+    limit=10
+)
+
+# Fetch DOSM data
+data = client.opendosm.get_dataset_as_json(id="cpi_2d_category")
+```
+
+## Documentation
+
+For detailed usage examples including all supported query filters (filtering, sorting, pagination, date ranges, column selection, and more), see the [Usage Guide](docs/usage.md).
+
+## API Reference
+
+This SDK wraps the [data.gov.my Open API](https://developer.data.gov.my/). Dataset IDs can be discovered at:
+
+- [data.gov.my Data Catalogue](https://data.gov.my/data-catalogue)
+- [OpenDOSM Data Catalogue](https://open.dosm.gov.my/data-catalogue)
+
+## Rate Limits
+
+- Without API key: **4 requests/minute**
+- With API key: **10 requests/minute**
+
+```python
+client = DataGovMyClient(api_key="your-api-key")
+```
+
+## License
+
+MIT

datagovmy_python_sdk-1.0.1.dist-info/RECORD

@@ -0,0 +1,12 @@
+datagovmy/__init__.py,sha256=oJ0M_JrIkHoUDTlBbn76AtpyzjafcacVjQFazi7XKic,79
+datagovmy/datagovmy.py,sha256=xWtAliQhHqbY6MvgTq8160acN2_zdxXqZ3OVWPukLQo,739
+datagovmy/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+datagovmy/core/api.py,sha256=oHuyGXOl9w0Ahs9eLpZXt48LWmuVAdE0r8LGqHV3McI,2441
+datagovmy/service/__init__.py,sha256=WZwmHeMjr1_uf_O_37facmhL7Rdp89ZPMmEfozHRLGE,173
+datagovmy/service/data_catalogue.py,sha256=hb_cdjPvuQH_J-4YdB5WWawGJVS82mjyyKq41w94T14,754
+datagovmy/service/environment.py,sha256=U5rTbYxoFBx8WdTVygdzO-bVseQCJL3OB0CrMmCp6wE,57
+datagovmy/service/exceptions.py,sha256=CNN8WXJk678minAo2lhYZrzKGz7A6Wk9vePbMUr9l9A,100
+datagovmy/service/open_dosm.py,sha256=pSLU3YgSjVF0ZnmZPJLh3ezzvt8xkB5S6LVKtBPO9Hc,743
+datagovmy_python_sdk-1.0.1.dist-info/METADATA,sha256=gwW9BcS5KOPHv9Z7K5343xRjCT7sIXwhHQTX6kmtnFc,1449
+datagovmy_python_sdk-1.0.1.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+datagovmy_python_sdk-1.0.1.dist-info/RECORD,,

datagovmy_python_sdk-1.0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any