kabukit 0.5.4__tar.gz → 0.6.0__tar.gz

{kabukit-0.5.4 → kabukit-0.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: kabukit
-Version: 0.5.4
+Version: 0.6.0
 Summary: A Python toolkit for Japanese financial market data, supporting J-Quants and EDINET APIs.
 Author: daizutabi
 Author-email: daizutabi <daizutabi@gmail.com>

{kabukit-0.5.4 → kabukit-0.6.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "uv_build"
 
 [project]
 name = "kabukit"
-version = "0.5.4"
+version = "0.6.0"
 description = "A Python toolkit for Japanese financial market data, supporting J-Quants and EDINET APIs."
 readme = "README.md"
 license = { file = "LICENSE" }

{kabukit-0.5.4 → kabukit-0.6.0}/src/kabukit/jquants/client.py

@@ -12,7 +12,7 @@ from kabukit.core.client import Client
 from kabukit.utils.config import load_dotenv, set_key
 from kabukit.utils.params import get_params
 
-from . import info, prices, statements
+from . import info, prices, statements, topix
 
 if TYPE_CHECKING:
     from collections.abc import AsyncIterator
@@ -342,3 +342,32 @@ class JQuantsClient(Client):
             return df
 
         return df.with_columns(pl.col("^.*Date$").str.to_date("%Y-%m-%d", strict=False))
+
+    async def get_topix(
+        self,
+        from_: str | datetime.date | None = None,
+        to: str | datetime.date | None = None,
+    ) -> DataFrame:
+        """日次のTOPIX指数データを取得する。
+
+        Args:
+            from_: 取得期間の開始日。
+            to: 取得期間の終了日。
+
+        Returns:
+            日次のTOPIX指数データを含むPolars DataFrame。
+
+        Raises:
+            HTTPStatusError: APIリクエストが失敗した場合。
+        """
+        params = get_params(from_=from_, to=to)
+
+        url = "/indices/topix"
+        name = "topix"
+
+        dfs = [df async for df in self.iter_pages(url, params, name)]
+        df = pl.concat(dfs)
+        if df.is_empty():
+            return df
+
+        return topix.clean(df)

kabukit-0.6.0/src/kabukit/jquants/topix.py

@@ -0,0 +1,16 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+import polars as pl
+
+if TYPE_CHECKING:
+    from polars import DataFrame
+
+
+def clean(df: DataFrame) -> DataFrame:
+    return df.select(
+        pl.col("Date").str.to_date("%Y-%m-%d"),
+        pl.lit("TOPIX").alias("Code"),
+        pl.exclude("Date"),
+    )