kabukit 0.2.0__py3-none-any.whl → 0.3.0__py3-none-any.whl

kabukit/cli/app.py

@@ -5,13 +5,14 @@ from __future__ import annotations
 import typer
 from async_typer import AsyncTyper  # pyright: ignore[reportMissingTypeStubs]
 
-from . import auth
+from . import auth, get
 
 app = AsyncTyper(
     add_completion=False,
     help="J-Quants/EDINETデータツール",
 )
 app.add_typer(auth.app, name="auth")
+app.add_typer(get.app, name="get")
 
 
 @app.command()

kabukit/cli/get.py

@@ -0,0 +1,104 @@
+from __future__ import annotations
+
+from typing import Annotated, Any
+
+import typer
+from async_typer import AsyncTyper  # pyright: ignore[reportMissingTypeStubs]
+from typer import Argument
+
+app = AsyncTyper(
+    add_completion=False,
+    help="J-Quantsからデータを取得します。",
+)
+
+Code = Annotated[
+    str | None,
+    Argument(help="銘柄コード。指定しない場合は全銘柄の情報を取得します。"),
+]
+
+
+@app.async_command()  # pyright: ignore[reportUnknownMemberType]
+async def info(code: Code = None) -> None:
+    """上場銘柄一覧を取得します。"""
+    from kabukit.core.info import Info
+    from kabukit.jquants.client import JQuantsClient
+
+    async with JQuantsClient() as client:
+        df = await client.get_info(code)
+
+    typer.echo(df)
+
+    if code is None:
+        path = Info(df).write()
+        typer.echo(f"全銘柄の情報を '{path}' に保存しました。")
+
+
+async def _fetch(
+    code: str | None,
+    target: str,
+    writer_cls: type,
+    fetch_func_name: str,
+    message: str,
+    **kwargs: Any,
+) -> None:
+    """財務情報・株価情報を取得するための共通処理"""
+    from kabukit.jquants.client import JQuantsClient
+
+    if code is not None:
+        async with JQuantsClient() as client:
+            df = await getattr(client, fetch_func_name)(code)
+        typer.echo(df)
+        return
+
+    import tqdm.asyncio
+
+    from kabukit.jquants.concurrent import fetch_all
+
+    df = await fetch_all(target, progress=tqdm.asyncio.tqdm, **kwargs)
+    typer.echo(df)
+    path = writer_cls(df).write()
+    typer.echo(f"全銘柄の{message}を '{path}' に保存しました。")
+
+
+@app.async_command()  # pyright: ignore[reportUnknownMemberType]
+async def statements(code: Code = None) -> None:
+    """財務情報を取得します。"""
+    from kabukit.core.statements import Statements
+
+    await _fetch(
+        code=code,
+        target="statements",
+        writer_cls=Statements,
+        fetch_func_name="get_statements",
+        message="財務情報",
+    )
+
+
+@app.async_command()  # pyright: ignore[reportUnknownMemberType]
+async def prices(code: Code = None) -> None:
+    """株価を取得します。"""
+    from kabukit.core.prices import Prices
+
+    await _fetch(
+        code=code,
+        target="prices",
+        writer_cls=Prices,
+        fetch_func_name="get_prices",
+        message="株価情報",
+        max_concurrency=8,
+    )
+
+
+@app.async_command(name="all")  # pyright: ignore[reportUnknownMemberType]
+async def all_(code: Code = None) -> None:
+    """上場銘柄一覧、財務情報、株価を連続して取得します。"""
+    typer.echo("上場銘柄一覧を取得します。")
+    await info(code)
+
+    typer.echo("---")
+    typer.echo("財務情報を取得します。")
+    await statements(code)
+
+    typer.echo("---")
+    typer.echo("株価を取得します。")
+    await prices(code)

kabukit/core/base.py

@@ -36,10 +36,15 @@ class Base:
     def read(cls, path: str | None = None) -> Self:
         data_dir = cls.data_dir()
 
-        if path is None:
-            filename = sorted(data_dir.glob("*.parquet"))[-1]
-        else:
+        if path:
             filename = data_dir / path
+        else:
+            filenames = sorted(data_dir.glob("*.parquet"))
+            if not filenames:
+                msg = f"No data found in {data_dir}"
+                raise FileNotFoundError(msg)
+
+            filename = filenames[-1]
 
         data = pl.read_parquet(filename)
         return cls(data)

kabukit/edinet/concurrent.py

@@ -1,13 +1,14 @@
 from __future__ import annotations
 
-import datetime
 from typing import TYPE_CHECKING
 
 from kabukit.utils import concurrent
+from kabukit.utils.date import get_dates
 
 from .client import EdinetClient
 
 if TYPE_CHECKING:
+    import datetime
     from collections.abc import Iterable
 
     from polars import DataFrame
@@ -15,30 +16,6 @@ if TYPE_CHECKING:
     from kabukit.utils.concurrent import Callback, Progress
 
 
-def get_dates(days: int | None = None, years: int | None = None) -> list[datetime.date]:
-    """過去days日またはyears年の日付リストを返す。
-
-    Args:
-        days (int | None): 過去days日の日付リストを取得する。
-        years (int | None): 過去years年の日付リストを取得する。
-            daysが指定されている場合は無視される。
-    """
-    end_date = datetime.date.today()  # noqa: DTZ011
-
-    if days is not None:
-        start_date = end_date - datetime.timedelta(days=days)
-    elif years is not None:
-        start_date = end_date.replace(year=end_date.year - years)
-    else:
-        msg = "daysまたはyearsのいずれかを指定してください。"
-        raise ValueError(msg)
-
-    return [
-        start_date + datetime.timedelta(days=i)
-        for i in range(1, (end_date - start_date).days + 1)
-    ]
-
-
 async def fetch(
     resource: str,
     args: Iterable[str | datetime.date],

kabukit/jquants/client.py

@@ -132,15 +132,18 @@ class JQuantsClient(Client):
         self,
         code: str | None = None,
         date: str | datetime.date | None = None,
+        *,
+        clean: bool = True,
     ) -> DataFrame:
         """銘柄情報を取得する。
 
         Args:
             code (str, optional): 情報を取得する銘柄のコード。
             date (str | datetime.date, optional): 情報を取得する日付。
+            clean (bool, optional): 取得したデータをクリーンアップするかどうか。
 
         Returns:
-            銘柄情報を含むPolars DataFrame。
+            銘柄情報を含むDataFrame。
 
         Raises:
             HTTPStatusError: APIリクエストが失敗した場合。
@@ -148,7 +151,8 @@ class JQuantsClient(Client):
         params = get_params(code=code, date=date)
         url = "/listed/info"
         data = await self.get(url, params)
-        return DataFrame(data["info"]).pipe(info.clean)
+        df = DataFrame(data["info"])
+        return info.clean(df) if clean else df
 
     async def iter_pages(
         self,
@@ -164,7 +168,7 @@ class JQuantsClient(Client):
             name (str): アイテムのリストを含むJSONレスポンスのキー。
 
         Yields:
-            データの各ページに対応するPolars DataFrame。
+            データの各ページに対応するDataFrame。
 
         Raises:
             HTTPStatusError: APIリクエストが失敗した場合。
@@ -185,6 +189,8 @@ class JQuantsClient(Client):
         date: str | datetime.date | None = None,
         from_: str | datetime.date | None = None,
         to: str | datetime.date | None = None,
+        *,
+        clean: bool = True,
     ) -> DataFrame:
         """日々の株価四本値を取得する。
 
@@ -198,16 +204,17 @@ class JQuantsClient(Client):
                 `date`とは併用不可。
             to (str | datetime.date, optional): 取得期間の終了日。
                 `date`とは併用不可。
+            clean (bool, optional): 取得したデータをクリーンアップするかどうか。
 
         Returns:
-            日々の株価四本値を含むPolars DataFrame。
+            日々の株価四本値を含むDataFrame。
 
         Raises:
             ValueError: `date`と`from_`/`to`の両方が指定された場合。
             HTTPStatusError: APIリクエストが失敗した場合。
         """
         if not date and not code:
-            return await self.get_latest_available_prices()
+            return await self.get_latest_available_prices(clean=clean)
 
         if date and (from_ or to):
             msg = "dateとfrom/toの両方を指定することはできません。"
@@ -224,15 +231,20 @@ class JQuantsClient(Client):
         if df.is_empty():
             return df
 
-        return prices.clean(df)
+        return prices.clean(df) if clean else df
 
-    async def get_latest_available_prices(self, num_days: int = 30) -> DataFrame:
+    async def get_latest_available_prices(
+        self,
+        num_days: int = 30,
+        *,
+        clean: bool = True,
+    ) -> DataFrame:
         """直近利用可能な日付の株価を取得する。"""
         today = datetime.date.today()  # noqa: DTZ011
 
         for days in range(num_days):
             date = today - datetime.timedelta(days)
-            df = await self.get_prices(date=date)
+            df = await self.get_prices(date=date, clean=clean)
 
             if not df.is_empty():
                 return df
@@ -243,12 +255,15 @@ class JQuantsClient(Client):
         self,
         code: str | None = None,
         date: str | datetime.date | None = None,
+        *,
+        clean: bool = True,
     ) -> DataFrame:
         """四半期毎の決算短信サマリーおよび業績・配当の修正に関する開示情報を取得する。
 
         Args:
             code (str, optional): 財務情報を取得する銘柄のコード。
             date (str | datetime.date, optional): 財務情報を取得する日付。
+            clean (bool, optional): 取得したデータをクリーンアップするかどうか。
 
         Returns:
             財務情報を含むDataFrame。
@@ -271,7 +286,7 @@ class JQuantsClient(Client):
         if df.is_empty():
             return df
 
-        return statements.clean(df)
+        return statements.clean(df) if clean else df
 
     async def get_announcement(self) -> DataFrame:
         """翌日発表予定の決算情報を取得する。

kabukit/jquants/statements.py

@@ -2,25 +2,14 @@ from __future__ import annotations
 
 import datetime
 from functools import cache
-from typing import TYPE_CHECKING, Any, Protocol
+from typing import TYPE_CHECKING
 
 import holidays
 import polars as pl
 
 if TYPE_CHECKING:
-    from collections.abc import AsyncIterable, AsyncIterator
-
     from polars import DataFrame
 
-    class Progress(Protocol):
-        def __call__[T](
-            self,
-            async_iterable: AsyncIterable[T],
-            total: int | None = None,
-            *args: Any,
-            **kwargs: Any,
-        ) -> AsyncIterator[T]: ...
-
 
 def clean(df: DataFrame) -> DataFrame:
     return (

kabukit/utils/concurrent.py

@@ -23,13 +23,14 @@ if TYPE_CHECKING:
     from kabukit.core.client import Client
 
     class _Progress(Protocol):
-        def __call__[T](
+        def __call__(
             self,
-            aiterable: AsyncIterable[T],
+            aiterable: AsyncIterable[Any],
+            /,
             total: int | None = None,
             *args: Any,
             **kwargs: Any,
-        ) -> AsyncIterator[T]: ...
+        ) -> AsyncIterator[Any]: ...
 
 
 MAX_CONCURRENCY = 12

kabukit/utils/config.py

@@ -1,13 +1,11 @@
 from __future__ import annotations
 
-from functools import cache
 from pathlib import Path
 
 import dotenv
 from platformdirs import user_config_dir
 
 
-@cache
 def get_dotenv_path() -> Path:
     """Return the path to the .env file in the user config directory."""
     config_dir = Path(user_config_dir("kabukit"))
@@ -15,12 +13,11 @@ def get_dotenv_path() -> Path:
     return config_dir / ".env"
 
 
-@cache
-def load_dotenv() -> bool:
+def set_key(key: str, value: str) -> tuple[bool | None, str, str]:
     dotenv_path = get_dotenv_path()
-    return dotenv.load_dotenv(dotenv_path)
+    return dotenv.set_key(dotenv_path, key, value)
 
 
-def set_key(key: str, value: str) -> tuple[bool | None, str, str]:
+def load_dotenv() -> bool:
     dotenv_path = get_dotenv_path()
-    return dotenv.set_key(dotenv_path, key, value)
+    return dotenv.load_dotenv(dotenv_path)

kabukit/utils/date.py

@@ -0,0 +1,27 @@
+from __future__ import annotations
+
+import datetime
+
+
+def get_dates(days: int | None = None, years: int | None = None) -> list[datetime.date]:
+    """過去days日またはyears年の日付リストを返す。
+
+    Args:
+        days (int | None): 過去days日の日付リストを取得する。
+        years (int | None): 過去years年の日付リストを取得する。
+            daysが指定されている場合は無視される。
+    """
+    end_date = datetime.date.today()  # noqa: DTZ011
+
+    if days is not None:
+        start_date = end_date - datetime.timedelta(days=days)
+    elif years is not None:
+        start_date = end_date.replace(year=end_date.year - years)
+    else:
+        msg = "daysまたはyearsのいずれかを指定してください。"
+        raise ValueError(msg)
+
+    return [
+        start_date + datetime.timedelta(days=i)
+        for i in range(1, (end_date - start_date).days + 1)
+    ]

kabukit/utils/params.py

@@ -18,16 +18,16 @@ def iter_items(kwargs: dict[str, Any]) -> Iterator[tuple[str, Any]]:
             yield key, value
 
 
-def get_params(**kwargs: Any) -> dict[str, str]:
-    params: dict[str, str] = {}
+def get_params(**kwargs: Any) -> dict[str, Any]:
+    params: dict[str, Any] = {}
 
     for key, value in iter_items(kwargs):
         if isinstance(value, datetime.date):
             params[key] = date_to_str(value)
-        elif not isinstance(value, str):
-            params[key] = str(value)
-        else:
+        elif isinstance(value, str | int | float | bool):
             params[key] = value
+        else:
+            params[key] = str(value)
 
     return params
 

{kabukit-0.2.0.dist-info → kabukit-0.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: kabukit
-Version: 0.2.0
+Version: 0.3.0
 Summary: A Python toolkit for Japanese financial market data, supporting J-Quants and EDINET APIs.
 Author: daizutabi
 Author-email: daizutabi <daizutabi@gmail.com>
@@ -27,21 +27,19 @@ License: MIT License
          SOFTWARE.
 Classifier: Development Status :: 4 - Beta
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: altair>=5
 Requires-Dist: async-typer>=0.1
 Requires-Dist: holidays>=0.81
 Requires-Dist: httpx>=0.28.1
-Requires-Dist: marimo[lsp]>=0.16
 Requires-Dist: platformdirs>=4
 Requires-Dist: polars>=1
 Requires-Dist: python-dotenv>=1
 Requires-Dist: typer>=0.19
-Requires-Dist: vegafusion-python-embed>=1.6
-Requires-Dist: vegafusion>=2
-Requires-Dist: vl-convert-python>=1.8
-Requires-Python: >=3.12
+Requires-Python: >=3.13
+Project-URL: Documentation, https://daizutabi.github.io/kabukit/
+Project-URL: Issues, https://github.com/daizutabi/kabukit/issues
+Project-URL: Source, https://github.com/daizutabi/kabukit
 Description-Content-Type: text/markdown
 
 # kabukit
@@ -50,6 +48,9 @@ A Python toolkit for Japanese financial market data, supporting J-Quants and EDI
 
 [![PyPI Version][pypi-v-image]][pypi-v-link]
 [![Python Version][python-v-image]][python-v-link]
+[![Build Status][GHAction-image]][GHAction-link]
+[![Coverage Status][codecov-image]][codecov-link]
+[![Documentation Status][docs-image]][docs-link]
 
 ## Installation
 
@@ -58,7 +59,14 @@ pip install kabukit
 ```
 
 <!-- Badges -->
+
 [pypi-v-image]: https://img.shields.io/pypi/v/kabukit.svg
 [pypi-v-link]: https://pypi.org/project/kabukit/
 [python-v-image]: https://img.shields.io/pypi/pyversions/kabukit.svg
 [python-v-link]: https://pypi.org/project/kabukit
+[GHAction-image]: https://github.com/daizutabi/kabukit/actions/workflows/ci.yaml/badge.svg?branch=main&event=push
+[GHAction-link]: https://github.com/daizutabi/kabukit/actions?query=event%3Apush+branch%3Amain
+[codecov-image]: https://codecov.io/github/daizutabi/kabukit/graph/badge.svg?token=Yu6lAdVVnd
+[codecov-link]: https://codecov.io/github/daizutabi/kabukit?branch=main
+[docs-image]: https://img.shields.io/badge/docs-latest-blue.svg
+[docs-link]: https://daizutabi.github.io/kabukit/

{kabukit-0.2.0.dist-info → kabukit-0.3.0.dist-info}/RECORD

@@ -5,31 +5,33 @@ kabukit/analysis/preprocess.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuF
 kabukit/analysis/screener.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kabukit/analysis/visualization.py,sha256=VS9WXBKcdOYsnVe-OR3cWP_nru3Oa-rBOK5SUwsxfyQ,1857
 kabukit/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-kabukit/cli/app.py,sha256=LjAq_Pj5_bokL4bCZ2R8OoP_zEBA-a2EG0Pm1ZCn7o8,491
+kabukit/cli/app.py,sha256=HKzxE2ue_VvdVazCFcU25PmDs3LJIjKvO7l-jdYJV_E,531
 kabukit/cli/auth.py,sha256=MWLxEiINrqMGJSiVHcv09EuPlyGeCitHqJq7kumzbr8,2735
+kabukit/cli/get.py,sha256=-qeoy6XRqj6fdGcTRPaA-ZAJlGFWMK7QOFNVeEtSPeM,2913
 kabukit/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-kabukit/core/base.py,sha256=kqaqtYHHFK8xC3z8QkLFv8CAV6FEZDDoiVY2Qwe9iM8,1125
+kabukit/core/base.py,sha256=SSUPzcFot0shN5nRY4cKN_Rt13TBBcyxHwqqwT-vcac,1280
 kabukit/core/client.py,sha256=lvjrshzOjyea2jRmc11Dl5OAJUGGN3PfKXWxoveG6hY,664
 kabukit/core/info.py,sha256=5BX7mDavF6g-b0KzHgKIFHUS5701BoaHtw1JcHSsy94,174
 kabukit/core/prices.py,sha256=Axm9cceVxnHIWCW6IHqEuCC4M73JtWCRzjXA42Qd7JE,781
 kabukit/core/statements.py,sha256=18vD5WRjBGVSXvmCfTvGAwgjnajLbN-tH6V91sX44iI,94
 kabukit/edinet/__init__.py,sha256=9bAWDIgVZKw84GF4z6FilUP_B22ih-ixLm8cQHxaoS8,77
 kabukit/edinet/client.py,sha256=OSz8BmSBzzZMD-wk_9WbhZLfDY901s5CN1UissoDtyc,3410
-kabukit/edinet/concurrent.py,sha256=du4TG0WwfkiWvxznXh-P0u1E_8mjTHBNivCIVmpieUg,5496
+kabukit/edinet/concurrent.py,sha256=RCNiD1hCP0Yat78IzfF4709tn_QgD1CTS17g_fNl7ZQ,4656
 kabukit/edinet/doc.py,sha256=ieze_886Tzkp6QYRJD3GuSXj6-LS43MqmA72zEx1kjA,959
 kabukit/jquants/__init__.py,sha256=n-sg0pLajSfyJ8snU6I_Q52rwmuaGCwAyz1yVbeMSw4,75
-kabukit/jquants/client.py,sha256=nyBAD2hspz_bLtkTLUgFGGRz9oZXXkXONV1exjW9O1s,10704
+kabukit/jquants/client.py,sha256=cszePJwByMgDJ4hFGrkEQeWchRb2HsNS48dzePKl7Kk,11257
 kabukit/jquants/concurrent.py,sha256=5XObYKMMYNmrq-8JLtVg0uBGoEJwI9Luvy6ndamiTz8,3288
 kabukit/jquants/info.py,sha256=AUymo6EtLdJ_L-0yNG1gd7rJ8Jkjw7tvsDM5Vw4QNFA,843
 kabukit/jquants/prices.py,sha256=oApQpdgzHwPw11XHpdg8ccZS7kybGtV8APZlpD2L3Yw,882
 kabukit/jquants/schema.py,sha256=HIoKDoIWrT0XNDHz5Fm4DtDGLLRqrq6TIkMTvq_Jheg,9647
-kabukit/jquants/statements.py,sha256=rPfIVJjWeEviWEtjPRUGesHyIpQKMfBxDLTXJzkYBdA,2995
+kabukit/jquants/statements.py,sha256=H-Ymat2gqAOsTaBNPtqLj8-5MLda72UkJW8SK2PvD5Q,2674
 kabukit/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kabukit/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-kabukit/utils/concurrent.py,sha256=7eXk29IhDLGroCCMIb8ucVqLMV9tYh0o2jYCoAU5tVM,4494
-kabukit/utils/config.py,sha256=Bsa_BGxNsHyaLWkC99oliRRPmkv5K0YKSdYF-ADGjck,660
-kabukit/utils/params.py,sha256=a5QLxTyB6jegeXDerQNmpYEKdZplhL3GnJuK0WRbBtQ,1091
-kabukit-0.2.0.dist-info/WHEEL,sha256=-neZj6nU9KAMg2CnCY6T3w8J53nx1kFGw_9HfoSzM60,79
-kabukit-0.2.0.dist-info/entry_points.txt,sha256=vvX771TemoM-35vVizW3JJ70HvRXnd2tX4P1Btzyoxs,46
-kabukit-0.2.0.dist-info/METADATA,sha256=SuzdQfFqziFhEsJq_8v4UQ91XIkQhgp3qKRiayZh3uk,2584
-kabukit-0.2.0.dist-info/RECORD,,
+kabukit/utils/concurrent.py,sha256=m2zVqJUz4xFVpNbEc9YEaj3Jmbl82njupdm4_rBOoYQ,4510
+kabukit/utils/config.py,sha256=Jp-2TCnIj_QqA71FzYCkHXbvXvhw_1JVl4PR0foA1vM,618
+kabukit/utils/date.py,sha256=DEC6Ac5LS8eiW6JtrmcD3U1pX4qzXtx4ale0swpO4Ag,937
+kabukit/utils/params.py,sha256=qcaJbf6CWPUoZAZsYDTaZSnBUWeAersbWnR_iiYW9GM,1108
+kabukit-0.3.0.dist-info/WHEEL,sha256=-neZj6nU9KAMg2CnCY6T3w8J53nx1kFGw_9HfoSzM60,79
+kabukit-0.3.0.dist-info/entry_points.txt,sha256=vvX771TemoM-35vVizW3JJ70HvRXnd2tX4P1Btzyoxs,46
+kabukit-0.3.0.dist-info/METADATA,sha256=UiJ_0PCOg-ghUW5iCdh7Tpxy4-NtgGChhzGI7gkoncM,3214
+kabukit-0.3.0.dist-info/RECORD,,