datagsm-openapi-sdk 1.0.0__tar.gz

datagsm_openapi_sdk-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 themoment-team
+
+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.

datagsm_openapi_sdk-1.0.0/PKG-INFO

@@ -0,0 +1,55 @@
+Metadata-Version: 2.4
+Name: datagsm-openapi-sdk
+Version: 1.0.0
+Summary: Python SDK for DataGSM OpenAPI
+Author-email: themoment-team <datagsm.oauth@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/themoment-team/datagsm-openapi-sdk-python
+Project-URL: Documentation, https://docs.themoment.io/datagsm/openapi/sdk/python
+Project-URL: Repository, https://github.com/themoment-team/datagsm-openapi-sdk-python
+Project-URL: Issues, https://github.com/themoment-team/datagsm-openapi-sdk-python/issues
+Project-URL: API Documentation, https://openapi.data.hellogsm.kr
+Keywords: datagsm,openapi,sdk,api-client
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx<1.0,>=0.27.0
+Requires-Dist: pydantic<3.0,>=2.0.0
+Requires-Dist: typing-extensions>=4.5.0
+Provides-Extra: dev
+Requires-Dist: mypy>=1.8.0; extra == "dev"
+Requires-Dist: ruff>=0.3.0; extra == "dev"
+Dynamic: license-file
+
+## DataGSM OpenAPI SDK for Python
+[![PyPI](https://img.shields.io/pypi/v/datagsm-openapi-sdk)](https://pypi.org/project/datagsm-openapi-sdk/)
+[![License](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
+[![Python](https://img.shields.io/badge/Python-3.9%2B-blue.svg)](https://www.python.org/)
+
+DataGSM의 OpenAPI를 추상화된 환경에서 제공합니다.
+
+### 설치 - pip
+
+```bash
+pip install datagsm-openapi-sdk
+````
+
+### 설치 - uv
+```bash
+uv pip install datagsm-openapi-sdk
+```
+
+### 사용법
+자세한 사용법은 [기술 문서](https://docs.themoment.io/datagsm/openapi/sdk/python)를 참고하십시오.

datagsm_openapi_sdk-1.0.0/README.md

@@ -0,0 +1,20 @@
+## DataGSM OpenAPI SDK for Python
+[![PyPI](https://img.shields.io/pypi/v/datagsm-openapi-sdk)](https://pypi.org/project/datagsm-openapi-sdk/)
+[![License](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
+[![Python](https://img.shields.io/badge/Python-3.9%2B-blue.svg)](https://www.python.org/)
+
+DataGSM의 OpenAPI를 추상화된 환경에서 제공합니다.
+
+### 설치 - pip
+
+```bash
+pip install datagsm-openapi-sdk
+````
+
+### 설치 - uv
+```bash
+uv pip install datagsm-openapi-sdk
+```
+
+### 사용법
+자세한 사용법은 [기술 문서](https://docs.themoment.io/datagsm/openapi/sdk/python)를 참고하십시오.

datagsm_openapi_sdk-1.0.0/pyproject.toml

@@ -0,0 +1,107 @@
+[build-system]
+requires = ["setuptools>=68.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "datagsm-openapi-sdk"
+version = "1.0.0"
+description = "Python SDK for DataGSM OpenAPI"
+readme = "README.md"
+requires-python = ">=3.9"
+license = {text = "MIT"}
+authors = [
+    {name = "themoment-team", email = "datagsm.oauth@gmail.com"}
+]
+keywords = ["datagsm", "openapi", "sdk", "api-client"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed",
+]
+
+dependencies = [
+    "httpx>=0.27.0,<1.0",
+    "pydantic>=2.0.0,<3.0",
+    "typing-extensions>=4.5.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "mypy>=1.8.0",
+    "ruff>=0.3.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/themoment-team/datagsm-openapi-sdk-python"
+Documentation = "https://docs.themoment.io/datagsm/openapi/sdk/python"
+Repository = "https://github.com/themoment-team/datagsm-openapi-sdk-python"
+Issues = "https://github.com/themoment-team/datagsm-openapi-sdk-python/issues"
+"API Documentation" = "https://openapi.data.hellogsm.kr"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+datagsm_openapi = ["py.typed"]
+
+[tool.mypy]
+python_version = "3.9"
+strict = true
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+disallow_any_generics = true
+disallow_subclassing_any = true
+disallow_untyped_calls = true
+disallow_incomplete_defs = true
+check_untyped_defs = true
+disallow_untyped_decorators = true
+no_implicit_optional = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+warn_no_return = true
+follow_imports = "normal"
+show_error_codes = true
+
+[tool.ruff]
+target-version = "py39"
+line-length = 100
+src = ["src"]
+
+[tool.ruff.lint]
+select = [
+    "E",   # pycodestyle errors
+    "W",   # pycodestyle warnings
+    "F",   # pyflakes
+    "I",   # isort
+    "N",   # pep8-naming
+    "UP",  # pyupgrade
+    "ANN", # flake8-annotations
+    "B",   # flake8-bugbear
+    "C4",  # flake8-comprehensions
+    "DTZ", # flake8-datetimez
+    "T10", # flake8-debugger
+    "RUF", # Ruff-specific rules
+]
+ignore = [
+    "ANN101", # Missing type annotation for self
+    "ANN102", # Missing type annotation for cls
+    "ANN401", # Dynamically typed expressions (Any) - needed for *args in context managers
+    "N818",   # Exception naming - DataGsmException is the intended name
+    "UP035",  # typing.Type vs type - Python 3.9 compatibility
+    "UP006",  # Type[T] vs type[T] - Python 3.9 compatibility
+    "N812",   # Lowercase imported as non-lowercase - intentional (date as Date)
+    "DTZ011", # date.today() without timezone - acceptable for our use case
+]
+
+[tool.ruff.lint.isort]
+known-first-party = ["datagsm_openapi"]

datagsm_openapi_sdk-1.0.0/setup.cfg

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

datagsm_openapi_sdk-1.0.0/src/datagsm_openapi/__init__.py

@@ -0,0 +1,61 @@
+"""DataGSM OpenAPI SDK for Python.
+
+Official Python SDK for the DataGSM OpenAPI service.
+
+Example:
+    Basic usage::
+
+        from datagsm_openapi import DataGsmClient
+
+        with DataGsmClient(api_key="your-api-key") as client:
+            students = client.students.get_students()
+            print(f"Total students: {students.total_elements}")
+"""
+
+from .api import (
+    ClubApi,
+    ClubRequest,
+    MealRequest,
+    NeisApi,
+    ProjectApi,
+    ProjectRequest,
+    ScheduleRequest,
+    StudentApi,
+    StudentRequest,
+)
+from .client import DataGsmClient
+from .exceptions import (
+    BadRequestException,
+    DataGsmException,
+    ForbiddenException,
+    NetworkException,
+    NotFoundException,
+    RateLimitException,
+    ServerErrorException,
+    UnauthorizedException,
+    ValidationException,
+)
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "BadRequestException",
+    "ClubApi",
+    "ClubRequest",
+    "DataGsmClient",
+    "DataGsmException",
+    "ForbiddenException",
+    "MealRequest",
+    "NeisApi",
+    "NetworkException",
+    "NotFoundException",
+    "ProjectApi",
+    "ProjectRequest",
+    "RateLimitException",
+    "ScheduleRequest",
+    "ServerErrorException",
+    "StudentApi",
+    "StudentRequest",
+    "UnauthorizedException",
+    "ValidationException",
+]

datagsm_openapi_sdk-1.0.0/src/datagsm_openapi/_http.py

@@ -0,0 +1,291 @@
+"""HTTP client abstraction layer for DataGSM OpenAPI SDK."""
+
+from typing import Any, Optional
+
+import httpx
+
+from .exceptions import (
+    BadRequestException,
+    DataGsmException,
+    ForbiddenException,
+    NetworkException,
+    NotFoundException,
+    RateLimitException,
+    ServerErrorException,
+    UnauthorizedException,
+)
+
+
+class HttpClient:
+    """HTTP client wrapper around httpx with error handling.
+
+    This class provides a clean interface for making HTTP requests to the DataGSM API
+    with automatic error handling and exception mapping.
+
+    Attributes:
+        base_url: Base URL for the API
+        api_key: API key for authentication
+        timeout: Request timeout in seconds
+    """
+
+    def __init__(
+        self,
+        base_url: str,
+        api_key: str,
+        timeout: float = 30.0,
+    ) -> None:
+        """Initialize the HTTP client.
+
+        Args:
+            base_url: Base URL for the API
+            api_key: API key for authentication
+            timeout: Request timeout in seconds (default: 30.0)
+        """
+        self.base_url = base_url.rstrip("/")
+        self.api_key = api_key
+        self.timeout = timeout
+        self._client: Optional[httpx.Client] = None
+
+    def __enter__(self) -> "HttpClient":
+        """Enter context manager."""
+        self._client = httpx.Client(
+            base_url=self.base_url,
+            timeout=self.timeout,
+            headers=self._get_headers(),
+        )
+        return self
+
+    def __exit__(self, *args: Any) -> None:
+        """Exit context manager and close the client."""
+        self.close()
+
+    def _get_headers(self) -> dict[str, str]:
+        """Get common headers for all requests.
+
+        Returns:
+            Dictionary of HTTP headers
+        """
+        return {
+            "X-API-KEY": self.api_key,
+            "Accept": "application/json",
+            "User-Agent": "datagsm-openapi-sdk-python/0.1.0",
+        }
+
+    def _get_client(self) -> httpx.Client:
+        """Get or create the HTTP client.
+
+        Returns:
+            The httpx.Client instance
+        """
+        if self._client is None:
+            self._client = httpx.Client(
+                base_url=self.base_url,
+                timeout=self.timeout,
+                headers=self._get_headers(),
+            )
+        return self._client
+
+    def _handle_error(self, response: httpx.Response) -> None:
+        """Handle HTTP error responses.
+
+        Args:
+            response: The HTTP response object
+
+        Raises:
+            BadRequestException: For 400 errors
+            UnauthorizedException: For 401 errors
+            ForbiddenException: For 403 errors
+            NotFoundException: For 404 errors
+            RateLimitException: For 429 errors
+            ServerErrorException: For 5xx errors
+            DataGsmException: For other errors
+        """
+        try:
+            error_body = response.json()
+            error_message = error_body.get("message", response.text)
+        except Exception:
+            error_body = None
+            error_message = response.text or f"HTTP {response.status_code} error"
+
+        status_code = response.status_code
+
+        if status_code == 400:
+            raise BadRequestException(message=error_message, response_body=error_body)
+        elif status_code == 401:
+            raise UnauthorizedException(message=error_message, response_body=error_body)
+        elif status_code == 403:
+            raise ForbiddenException(message=error_message, response_body=error_body)
+        elif status_code == 404:
+            raise NotFoundException(message=error_message, response_body=error_body)
+        elif status_code == 429:
+            raise RateLimitException(message=error_message, response_body=error_body)
+        elif 500 <= status_code < 600:
+            raise ServerErrorException(
+                message=error_message,
+                status_code=status_code,
+                response_body=error_body,
+            )
+        else:
+            raise DataGsmException(
+                message=error_message,
+                status_code=status_code,
+                response_body=error_body,
+            )
+
+    def get(
+        self,
+        path: str,
+        params: Optional[dict[str, Any]] = None,
+    ) -> dict[str, Any]:
+        """Make a GET request.
+
+        Args:
+            path: API endpoint path (e.g., "/students")
+            params: Query parameters
+
+        Returns:
+            JSON response as a dictionary
+
+        Raises:
+            NetworkException: For connection or timeout errors
+            DataGsmException: For API errors
+        """
+        try:
+            client = self._get_client()
+            response = client.get(path, params=params)
+            response.raise_for_status()
+            return response.json()  # type: ignore[no-any-return]
+        except httpx.HTTPStatusError as e:
+            self._handle_error(e.response)
+            raise  # This line will never be reached, but makes mypy happy
+        except (httpx.ConnectError, httpx.TimeoutException) as e:
+            raise NetworkException(
+                message=f"Network error: {e!s}",
+                original_exception=e,
+            ) from e
+        except httpx.HTTPError as e:
+            raise NetworkException(
+                message=f"HTTP error: {e!s}",
+                original_exception=e,
+            ) from e
+
+    def post(
+        self,
+        path: str,
+        json: Optional[dict[str, Any]] = None,
+        params: Optional[dict[str, Any]] = None,
+    ) -> dict[str, Any]:
+        """Make a POST request.
+
+        Args:
+            path: API endpoint path
+            json: JSON request body
+            params: Query parameters
+
+        Returns:
+            JSON response as a dictionary
+
+        Raises:
+            NetworkException: For connection or timeout errors
+            DataGsmException: For API errors
+        """
+        try:
+            client = self._get_client()
+            response = client.post(path, json=json, params=params)
+            response.raise_for_status()
+            return response.json()  # type: ignore[no-any-return]
+        except httpx.HTTPStatusError as e:
+            self._handle_error(e.response)
+            raise
+        except (httpx.ConnectError, httpx.TimeoutException) as e:
+            raise NetworkException(
+                message=f"Network error: {e!s}",
+                original_exception=e,
+            ) from e
+        except httpx.HTTPError as e:
+            raise NetworkException(
+                message=f"HTTP error: {e!s}",
+                original_exception=e,
+            ) from e
+
+    def put(
+        self,
+        path: str,
+        json: Optional[dict[str, Any]] = None,
+        params: Optional[dict[str, Any]] = None,
+    ) -> dict[str, Any]:
+        """Make a PUT request.
+
+        Args:
+            path: API endpoint path
+            json: JSON request body
+            params: Query parameters
+
+        Returns:
+            JSON response as a dictionary
+
+        Raises:
+            NetworkException: For connection or timeout errors
+            DataGsmException: For API errors
+        """
+        try:
+            client = self._get_client()
+            response = client.put(path, json=json, params=params)
+            response.raise_for_status()
+            return response.json()  # type: ignore[no-any-return]
+        except httpx.HTTPStatusError as e:
+            self._handle_error(e.response)
+            raise
+        except (httpx.ConnectError, httpx.TimeoutException) as e:
+            raise NetworkException(
+                message=f"Network error: {e!s}",
+                original_exception=e,
+            ) from e
+        except httpx.HTTPError as e:
+            raise NetworkException(
+                message=f"HTTP error: {e!s}",
+                original_exception=e,
+            ) from e
+
+    def delete(
+        self,
+        path: str,
+        params: Optional[dict[str, Any]] = None,
+    ) -> dict[str, Any]:
+        """Make a DELETE request.
+
+        Args:
+            path: API endpoint path
+            params: Query parameters
+
+        Returns:
+            JSON response as a dictionary
+
+        Raises:
+            NetworkException: For connection or timeout errors
+            DataGsmException: For API errors
+        """
+        try:
+            client = self._get_client()
+            response = client.delete(path, params=params)
+            response.raise_for_status()
+            return response.json()  # type: ignore[no-any-return]
+        except httpx.HTTPStatusError as e:
+            self._handle_error(e.response)
+            raise
+        except (httpx.ConnectError, httpx.TimeoutException) as e:
+            raise NetworkException(
+                message=f"Network error: {e!s}",
+                original_exception=e,
+            ) from e
+        except httpx.HTTPError as e:
+            raise NetworkException(
+                message=f"HTTP error: {e!s}",
+                original_exception=e,
+            ) from e
+
+    def close(self) -> None:
+        """Close the HTTP client and release resources."""
+        if self._client is not None:
+            self._client.close()
+            self._client = None

datagsm_openapi_sdk-1.0.0/src/datagsm_openapi/_json.py

@@ -0,0 +1,53 @@
+"""JSON serialization utilities for DataGSM OpenAPI SDK."""
+
+from datetime import date, datetime
+from typing import Any
+
+
+def serialize_date(value: date) -> str:
+    """Serialize a date to ISO format string.
+
+    Args:
+        value: Date object to serialize
+
+    Returns:
+        ISO format date string (YYYY-MM-DD)
+    """
+    return value.isoformat()
+
+
+def serialize_datetime(value: datetime) -> str:
+    """Serialize a datetime to ISO format string.
+
+    Args:
+        value: Datetime object to serialize
+
+    Returns:
+        ISO format datetime string
+    """
+    return value.isoformat()
+
+
+def clean_params(params: dict[str, Any]) -> dict[str, Any]:
+    """Clean query parameters by removing None values and serializing dates.
+
+    Args:
+        params: Dictionary of query parameters
+
+    Returns:
+        Cleaned dictionary with None values removed and dates serialized
+    """
+    cleaned: dict[str, Any] = {}
+    for key, value in params.items():
+        if value is None:
+            continue
+        if isinstance(value, datetime):
+            cleaned[key] = serialize_datetime(value)
+        elif isinstance(value, date):
+            cleaned[key] = serialize_date(value)
+        elif isinstance(value, bool):
+            # Convert boolean to lowercase string for query params
+            cleaned[key] = str(value).lower()
+        else:
+            cleaned[key] = value
+    return cleaned

datagsm_openapi_sdk-1.0.0/src/datagsm_openapi/api/__init__.py

@@ -0,0 +1,18 @@
+"""API modules for DataGSM OpenAPI SDK."""
+
+from .club import ClubApi, ClubRequest
+from .neis import MealRequest, NeisApi, ScheduleRequest
+from .project import ProjectApi, ProjectRequest
+from .student import StudentApi, StudentRequest
+
+__all__ = [
+    "ClubApi",
+    "ClubRequest",
+    "MealRequest",
+    "NeisApi",
+    "ProjectApi",
+    "ProjectRequest",
+    "ScheduleRequest",
+    "StudentApi",
+    "StudentRequest",
+]