dragonfipy 0.1.0__tar.gz

dragonfipy-0.1.0/PKG-INFO

@@ -0,0 +1,11 @@
+Metadata-Version: 2.3
+Name: dragonfipy
+Version: 0.1.0
+Summary: DragonFi API wrapper
+Author: Chris Irag
+Author-email: Chris Irag <iragca@pm.me>
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: python-dateutil>=2.9.0.post0
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+

dragonfipy-0.1.0/pyproject.toml

@@ -0,0 +1,42 @@
+[project]
+name = "dragonfipy"
+version = "0.1.0"
+description = "DragonFi API wrapper"
+readme = "README.md"
+requires-python = ">=3.13"
+dependencies = [
+    "httpx>=0.28.1",
+    "python-dateutil>=2.9.0.post0",
+]
+
+[[project.authors]]
+name = "Chris Irag"
+email = "iragca@pm.me"
+
+[build-system]
+requires = ["uv_build>=0.13.0,<0.14.0"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "dragonpy"
+module-root = "src"
+
+[tool.ruff]
+line-length = 79
+indent-width = 4
+
+[tool.ty.environment]
+python = ".venv"
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]
+testpaths = ["tests"]
+addopts = "--cov=src --cov-report=term-missing"
+
+[dependency-groups]
+dev = [
+    "pre-commit>=4.7.0",
+    "pytest>=9.1.1",
+    "pytest-cov>=7.1.0",
+    "ruff>=0.17.2",
+]

dragonfipy-0.1.0/pyproject.toml.orig

@@ -0,0 +1,38 @@
+[project]
+name = "dragonfipy"
+version = "0.1.0"
+description = "DragonFi API wrapper"
+readme = "README.md"
+authors = [{ name = "Chris Irag", email = "iragca@pm.me" }]
+requires-python = ">=3.13"
+dependencies = [
+    "httpx>=0.28.1",
+    "python-dateutil>=2.9.0.post0",
+]
+
+[build-system]
+requires = ["uv_build>=0.13.0,<0.14.0"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "dragonpy"
+module-root = "src"
+
+[tool.ruff]
+line-length = 79
+indent-width = 4
+
+[tool.ty.environment]
+python = ".venv"
+[dependency-groups]
+dev = [
+    "pre-commit>=4.7.0",
+    "pytest>=9.1.1",
+    "pytest-cov>=7.1.0",
+    "ruff>=0.17.2",
+]
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]
+testpaths = ["tests"]
+addopts = "--cov=src --cov-report=term-missing"

dragonfipy-0.1.0/src/dragonpy/__init__.py

@@ -0,0 +1,3 @@
+from .wrapper import DragonPy
+
+__all__ = ["DragonPy"]

dragonfipy-0.1.0/src/dragonpy/enums/__init__.py

@@ -0,0 +1,6 @@
+from http import HTTPStatus
+
+from .api import DragonFiAPI
+from .status import WSSStatus
+
+__all__ = ["DragonFiAPI", "HTTPStatus", "WSSStatus"]

dragonfipy-0.1.0/src/dragonpy/enums/api.py

@@ -0,0 +1,7 @@
+from enum import StrEnum
+
+
+class DragonFiAPI(StrEnum):
+    REST_V1 = "https://api.dragonfi.ph/api/"
+    REST_V2 = "https://api.dragonfi.ph/api/v2/"
+    WSS = "wss://api.dragonfi.ph/"

dragonfipy-0.1.0/src/dragonpy/enums/status.py

@@ -0,0 +1,67 @@
+# ------------------------------------------------------------------------------
+# Attribution
+# ------------------------------------------------------------------------------
+# Portions of this module are derived from:
+# https://github.com/Kludex/starlette/blob/7b2948fe7b7fff28bb018607d54cd4dfa518910e/starlette/status.py,
+# Copyright (c) 2018 Encode OSS Ltd., licensed under the BSD 3-Clause License.
+#
+# The following license text is retained as required by the upstream license:
+#
+# Copyright (c) 2018, Encode OSS Ltd.
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.
+#
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+#
+# * Neither the name of the copyright holder nor the names of its
+#   contributors may be used to endorse or promote products derived from
+#   this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+# ------------------------------------------------------------------------------
+
+from enum import IntEnum
+
+
+class WSSStatus(IntEnum):
+    """
+    WebSocket status codes.
+
+    WebSocket codes
+    ---------------
+    https://www.iana.org/assignments/websocket/websocket.xml#close-code-number
+    https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent
+    """
+
+    WS_1000_NORMAL_CLOSURE = 1000
+    WS_1001_GOING_AWAY = 1001
+    WS_1002_PROTOCOL_ERROR = 1002
+    WS_1003_UNSUPPORTED_DATA = 1003
+    WS_1005_NO_STATUS_RCVD = 1005
+    WS_1006_ABNORMAL_CLOSURE = 1006
+    WS_1007_INVALID_FRAME_PAYLOAD_DATA = 1007
+    WS_1008_POLICY_VIOLATION = 1008
+    WS_1009_MESSAGE_TOO_BIG = 1009
+    WS_1010_MANDATORY_EXT = 1010
+    WS_1011_INTERNAL_ERROR = 1011
+    WS_1012_SERVICE_RESTART = 1012
+    WS_1013_TRY_AGAIN_LATER = 1013
+    WS_1014_BAD_GATEWAY = 1014
+    WS_1015_TLS_HANDSHAKE = 1015

dragonfipy-0.1.0/src/dragonpy/exceptions.py

@@ -0,0 +1,132 @@
+# ------------------------------------------------------------------------------
+# Attribution
+# ------------------------------------------------------------------------------
+# Portions of this module are derived from:
+# https://github.com/Kludex/starlette/blob/7b2948fe7b7fff28bb018607d54cd4dfa518910e/starlette/exceptions.py,
+# Copyright (c) 2018 Encode OSS Ltd., licensed under the BSD 3-Clause License.
+#
+# The following license text is retained as required by the upstream license:
+#
+# Copyright (c) 2018, Encode OSS Ltd.
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.
+#
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+#
+# * Neither the name of the copyright holder nor the names of its
+#   contributors may be used to endorse or promote products derived from
+#   this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+# ------------------------------------------------------------------------------
+
+import http.client
+
+
+class HTTPException(Exception):
+    def __init__(
+        self,
+        status_code: int,
+        detail: str | None = None,
+        headers: dict[str, str] | None = None,
+    ) -> None:
+        if detail is None:
+            detail = http.client.responses.get(status_code, "")
+        self.status_code = status_code
+        self.detail = detail
+        self.headers = headers
+
+    def __str__(self) -> str:
+        return f"{self.status_code}: {self.detail}"
+
+    def __repr__(self) -> str:
+        class_name = self.__class__.__name__
+        return f"{class_name}(status_code={self.status_code!r}, detail={self.detail!r})"
+
+
+class WebSocketException(Exception):
+    def __init__(self, code: int, reason: str | None = None) -> None:
+        self.code = code
+        self.reason = reason or ""
+
+    def __str__(self) -> str:
+        return f"{self.code}: {self.reason}"
+
+    def __repr__(self) -> str:
+        class_name = self.__class__.__name__
+        return f"{class_name}(code={self.code!r}, reason={self.reason!r})"
+
+
+# ---------------------------------------------------------------------
+# Attribution
+# ---------------------------------------------------------------------
+# Portions of this module are derived from:
+# https://github.com/fastapi/fastapi/blob/f5c6e9b4f9cadc1bf0f9a1fd672e621206b63007/fastapi/exceptions.py
+# Copyright (c) 2018 Sebastián Ramírez, licensed under the MIT License.
+#
+# The following license text is retained as required by the upstream license:
+
+# The MIT License (MIT)
+
+# Copyright (c) 2018 Sebastián Ramírez
+
+# 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.
+
+
+class DragonPyError(RuntimeError):
+    """
+    A generic, DragonPy-specific error.
+    """
+
+    def __init__(self, message: str = ""):
+        self.message = message
+
+    def __str__(self) -> str:
+        if self.message == "":
+            return "DragonPy: Something unexpected happened"
+        return f"DragonPy: {self.message}"
+
+    def __repr__(self) -> str:
+        class_name = self.__class__.__name__
+        return f"{class_name}(message={self.message!r})"
+
+
+class DragonPyDeprecationWarning(UserWarning):
+    """
+    A custom deprecation warning as DeprecationWarning is ignored
+    Ref: https://sethmlarson.dev/deprecations-via-warnings-dont-work-for-python-libraries
+    """

dragonfipy-0.1.0/src/dragonpy/responses/dashboard.py

@@ -0,0 +1,18 @@
+from typing import TypedDict
+
+
+class Event(TypedDict):
+    type: str
+    symbol: str
+    candleType: str
+    open: float
+    high: float
+    low: float
+    volume: int
+    time: str
+    localtime: str
+    timeinSeconds: int
+
+
+class Events(TypedDict):
+    events: Event

dragonfipy-0.1.0/src/dragonpy/responses/securities.py

@@ -0,0 +1,70 @@
+from typing import TypedDict
+
+
+class RelatedStock(TypedDict):
+    stockCode: str
+    logoPath: str | None
+    change: float
+    changePercent: float
+    price: float
+
+
+class GetStockProfile(TypedDict):
+    description: str
+    symbol: str
+    full_name: str
+    type: str
+    exchange: str
+    codeAndName: str
+    price: float
+    prevDayClosePrice: float
+    dayOpenPrice: float
+    bidPrice: float | None
+    askPrice: float | None
+    change: float
+    changePercent: float
+    lastTradeTime: str
+    isMarketOpen: bool
+    relatedStocks: list[RelatedStock]
+    dayChangePricePercent: float
+    averageVolume10: float
+    averageVolume20: float
+    dayVolume: float
+    dayLowPrice: float
+    dayHighPrice: float
+    weekHigh52: float
+    weekLow52: float
+    companyName: str
+    companyShortName: str
+    stockCode: str
+    website: str
+    logoPath: str
+    productCode: str
+    shariahIndicator: str
+    industryId: int
+    industryCode: str
+    industryName: str
+    sectorId: int
+    sectorCode: str
+    sectorName: str
+    listingDate: str | None
+    parValue: float
+    lacp: float
+    shortSellingEligible: bool
+    isREIT: bool
+    isPreferredStock: bool | None
+    preferredParentStockCode: str | None
+    isPERA: bool
+    floatLevel: float
+    sharesOutstanding: int
+    sharesFloat: int
+    isin: str
+    isDDS: bool | None
+    isDelisted: bool | None
+    isOldSymbol: bool
+    isIndices: bool
+    dateDelisted: str | None
+    oldStockCode: str | None
+    oldCompanyName: str | None
+    dividendYield: float
+    id: int

dragonfipy-0.1.0/src/dragonpy/services/__init__.py

@@ -0,0 +1,6 @@
+from .dashboard import DashboardService
+from .funds import FundsService
+from .securities import SecuritiesService
+from .service import Service
+
+__all__ = ["DashboardService", "FundsService", "SecuritiesService", "Service"]

dragonfipy-0.1.0/src/dragonpy/services/dashboard.py

@@ -0,0 +1,75 @@
+from datetime import datetime
+from typing import Literal, cast
+
+from dateutil.relativedelta import relativedelta
+from httpx import Client
+
+from dragonpy.responses.dashboard import Events
+from dragonpy.services.service import Service
+
+
+class DashboardService(Service):
+    def __init__(self, client: Client, path: str = "Dashboard"):
+        super().__init__(client, path)
+
+    def get_delayed_bars(
+        self,
+        symbol: str,
+        candleType: Literal["1", "5", "15", "30", "1D", "1W", "1M"] = "1D",
+        count: int = 301,
+        delayInMinutes: int = 15,
+        time_range: tuple[datetime, datetime] | None = None,
+    ) -> Events:
+        """Get price action data for a specified symbol.
+
+        Parameters
+        ----------
+        symbol : str
+            Ticker symbol of the security or fund to fetch
+        candleType : str
+            1: 1 minute
+            5: 5 minutes
+            15: 15 minutes
+            30: 30 minutes
+            1D: 1 day
+            1W: 1 week
+            1M: 1 month
+        time_range : tuple[datetime, datetime] | None
+            The pair of datetimes for the time range. (startDate, endDate)
+        """
+        if symbol == "":
+            raise ValueError("Symbol must not be empty.")
+
+        params = {
+            "symbol": symbol.upper().strip(),
+            "candleType": candleType,
+            "count": count,
+            "delayInMinutes": delayInMinutes,
+        }
+
+        if time_range is None:
+            now = datetime.now()
+            params["fromTime"] = int(
+                (now - relativedelta(years=1)).timestamp()
+            )
+            params["toTime"] = int(now.timestamp())
+        else:
+            if len(time_range) != 2:
+                raise ValueError(
+                    "Time range must contain a start date and an end date."
+                )
+
+            start, end = time_range
+
+            if not isinstance(start, datetime) or not isinstance(
+                end, datetime
+            ):
+                raise TypeError("Time range values must be datetime objects.")
+
+            if start >= end:
+                raise ValueError("Start date must be earlier than end date.")
+
+            params["fromTime"] = int(time_range[0].timestamp())
+            params["toTime"] = int(time_range[1].timestamp())
+
+        return cast(Events, self._get("GetDelayedBars", params))

dragonfipy-0.1.0/src/dragonpy/services/funds.py

@@ -0,0 +1,8 @@
+from httpx import Client
+
+from .service import Service
+
+
+class FundsService(Service):
+    def __init__(self, client: Client, path: str = "Funds"):
+        super().__init__(client, path)

dragonfipy-0.1.0/src/dragonpy/services/securities.py

@@ -0,0 +1,18 @@
+from typing import cast
+
+from httpx import Client
+
+from dragonpy.responses.securities import GetStockProfile
+
+from .service import Service
+
+
+class SecuritiesService(Service):
+    def __init__(self, client: Client, path: str = "Securities"):
+        super().__init__(client, path)
+
+    def get_stock_profile(self, stockCode: str) -> GetStockProfile:
+        return cast(
+            GetStockProfile,
+            self._get("GetStockProfile", {"stockCode": stockCode}),
+        )

dragonfipy-0.1.0/src/dragonpy/services/service.py

@@ -0,0 +1,28 @@
+from json import loads
+from urllib.parse import urlencode
+
+from httpx import Client
+
+from dragonpy.enums import HTTPStatus
+from dragonpy.exceptions import HTTPException
+from dragonpy.utils import merge_url
+
+
+class Service:
+    def __init__(self, client: Client, path: str):
+        self.client: Client = client
+        self.service_url: str = merge_url(str(client.base_url), path)
+
+    def _get(self, function: str, params: dict[str, str | int]) -> dict:
+        base_url = merge_url(self.service_url, function)
+        queries = urlencode(params)
+        req_url = f"{base_url}?{queries}"
+        response = self.client.get(req_url)
+        status = HTTPStatus(response.status_code)
+        if status.is_success:
+            if response.content == b"":
+                return {}
+
+            return loads(response.content)
+
+        raise HTTPException(response.status_code, detail=req_url)

dragonfipy-0.1.0/src/dragonpy/utils.py

@@ -0,0 +1,20 @@
+from urllib.parse import urljoin
+
+
+def _join_two(left: str, right: str) -> str:
+    base = left if left.endswith("/") else left + "/"
+    return urljoin(base, right)
+
+
+def merge_url(*paths: str) -> str:
+    """Join paths regardless of the ending slash existing or not."""
+    if not paths:
+        raise ValueError("At least one path is required")
+
+    remaining = list(paths)
+    url = remaining.pop(0)
+
+    while remaining:
+        url = _join_two(url, remaining.pop(0))
+
+    return url

dragonfipy-0.1.0/src/dragonpy/wrapper.py

@@ -0,0 +1,13 @@
+from httpx import Client
+
+from dragonpy.enums import DragonFiAPI
+from dragonpy.services import DashboardService, FundsService, SecuritiesService
+
+
+class DragonPy:
+    def __init__(self, url: str | DragonFiAPI = DragonFiAPI.REST_V2):
+        self.api = url
+        self._client = Client(base_url=url, headers={"UserAgent": "dragonpy"})
+        self.dashboard = DashboardService(self._client, url)
+        self.funds = FundsService(self._client, url)
+        self.securities = SecuritiesService(self._client, url)