kabukit 0.7.6__tar.gz → 0.8.1__tar.gz

kabukit-0.8.1/PKG-INFO

@@ -0,0 +1,113 @@
+Metadata-Version: 2.3
+Name: kabukit
+Version: 0.8.1
+Summary: A Python toolkit for Japanese financial market data, supporting J-Quants and EDINET APIs.
+Keywords: J-Quants,EDINET,financial data,stock market,investment,toolkit,finance,trading,data analysis,polars
+Author: daizutabi
+Author-email: daizutabi <daizutabi@gmail.com>
+License: MIT License
+         
+         Copyright (c) 2025 Daizu
+         
+         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.
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Office/Business :: Financial
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Topic :: Utilities
+Requires-Dist: async-typer>=0.1.10
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: platformdirs>=4.5.0
+Requires-Dist: polars>=1.34.0
+Requires-Dist: python-dotenv>=1.1.1
+Requires-Dist: rich>=14.2.0
+Requires-Dist: tenacity>=9.1.2
+Requires-Dist: tqdm>=4.67.1
+Requires-Dist: typer>=0.19.2
+Requires-Dist: tzdata ; sys_platform == 'win32'
+Requires-Python: >=3.12
+Project-URL: Changelog, https://github.com/daizutabi/kabukit/releases
+Project-URL: Documentation, https://daizutabi.github.io/kabukit/
+Project-URL: Homepage, 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
+
+[![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]
+
+A Python toolkit for Japanese financial market data,
+supporting J-Quants and EDINET APIs.
+
+kabukit は、 [J-Quants API](https://jpx-jquants.com/) および [EDINET API](https://disclosure2dl.edinet-fsa.go.jp/guide/static/disclosure/WZEK0110.html) から、効率的に日本の金融市場データを取得するツールキットです。
+
+高速なデータ処理ライブラリである [Polars](https://pola.rs/) と、モダンな非同期 HTTP クライアントである [httpx](https://www.python-httpx.org/) を基盤として構築されており、パフォーマンスを重視しています。
+
+## インストール
+
+`pip` または `uv` を使ってインストールします。Python バージョンは 3.12 以上が必要です。
+
+```bash
+pip install kabukit
+```
+
+## コマンドラインから使う
+
+kabukit は、 [J-Quants API](https://jpx-jquants.com/) および [EDINET API](https://disclosure2dl.edinet-fsa.go.jp/guide/static/disclosure/WZEK0110.html) からデータを取得するための便利なコマンドラインインターフェース（CLI）を提供します。
+
+具体的な使い方は、次の利用ガイドを参照してください。
+
+- [コマンドラインインターフェースの使い方](https://daizutabi.github.io/kabukit/guides/cli/)
+
+## ノートブックから使う
+
+kabukit は、コマンドラインだけでなく、Python コードからも API として利用できます。httpx を使って非同期でデータを取得するため、[Jupyter](https://jupyter.org/) や [marimo](https://marimo.io/) のような非同期処理を直接扱えるノートブック環境と非常に相性が良いです。
+
+具体的な使い方は、以下の利用ガイドを参照してください。
+
+- [J-Quants API の使い方](https://daizutabi.github.io/kabukit/guides/jquants/)
+- [EDINET API の使い方](https://daizutabi.github.io/kabukit/guides/edinet/)
+
+<!-- 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.8.1/README.md

@@ -0,0 +1,52 @@
+# kabukit
+
+[![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]
+
+A Python toolkit for Japanese financial market data,
+supporting J-Quants and EDINET APIs.
+
+kabukit は、 [J-Quants API](https://jpx-jquants.com/) および [EDINET API](https://disclosure2dl.edinet-fsa.go.jp/guide/static/disclosure/WZEK0110.html) から、効率的に日本の金融市場データを取得するツールキットです。
+
+高速なデータ処理ライブラリである [Polars](https://pola.rs/) と、モダンな非同期 HTTP クライアントである [httpx](https://www.python-httpx.org/) を基盤として構築されており、パフォーマンスを重視しています。
+
+## インストール
+
+`pip` または `uv` を使ってインストールします。Python バージョンは 3.12 以上が必要です。
+
+```bash
+pip install kabukit
+```
+
+## コマンドラインから使う
+
+kabukit は、 [J-Quants API](https://jpx-jquants.com/) および [EDINET API](https://disclosure2dl.edinet-fsa.go.jp/guide/static/disclosure/WZEK0110.html) からデータを取得するための便利なコマンドラインインターフェース（CLI）を提供します。
+
+具体的な使い方は、次の利用ガイドを参照してください。
+
+- [コマンドラインインターフェースの使い方](https://daizutabi.github.io/kabukit/guides/cli/)
+
+## ノートブックから使う
+
+kabukit は、コマンドラインだけでなく、Python コードからも API として利用できます。httpx を使って非同期でデータを取得するため、[Jupyter](https://jupyter.org/) や [marimo](https://marimo.io/) のような非同期処理を直接扱えるノートブック環境と非常に相性が良いです。
+
+具体的な使い方は、以下の利用ガイドを参照してください。
+
+- [J-Quants API の使い方](https://daizutabi.github.io/kabukit/guides/jquants/)
+- [EDINET API の使い方](https://daizutabi.github.io/kabukit/guides/edinet/)
+
+<!-- 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.7.6 → kabukit-0.8.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "uv_build"
 
 [project]
 name = "kabukit"
-version = "0.7.6"
+version = "0.8.1"
 description = "A Python toolkit for Japanese financial market data, supporting J-Quants and EDINET APIs."
 readme = "README.md"
 license = { file = "LICENSE" }
@@ -25,6 +25,7 @@ classifiers = [
   "Development Status :: 4 - Beta",
   "Programming Language :: Python",
   "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.12",
   "Programming Language :: Python :: 3.13",
   "Programming Language :: Python :: 3.14",
   "License :: OSI Approved :: MIT License",
@@ -37,7 +38,7 @@ classifiers = [
   "Topic :: Scientific/Engineering :: Information Analysis",
   "Topic :: Utilities",
 ]
-requires-python = ">=3.13"
+requires-python = ">=3.12"
 dependencies = [
   "async-typer>=0.1.10",
   "httpx>=0.28.1",
@@ -65,8 +66,7 @@ Source = "https://github.com/daizutabi/kabukit"
 dev = [
   "altair @ git+https://github.com/vega/altair.git@main",
   "basedpyright>=1.31.6",
-  "marimo[lsp]>=0.16.5",
-  "numpy>=2.3.3",
+  "marimo[lsp,mcp]>=0.16.5",
   "pre-commit>=4.3.0",
   "pytest-asyncio>=1.2.0",
   "pytest-clarity>=1.0.1",
@@ -79,7 +79,16 @@ dev = [
   "vegafusion>=2.0.3",
   "vl-convert-python>=1.8.0",
 ]
-docs = ["mkapi>=4.4", "mkdocs-marimo", "mkdocs-material"]
+docs = [
+  "ipykernel>=6.30.1",
+  "markdown-exec[ansi]>=1.11.0",
+  "mkapi>=4.5",
+  "mkdocs-material>=9.6.21",
+  "mkdocs-nbsync>=0.1.5",
+  "mkdocs-typer>=0.0.3",
+  "nbconvert>=7.16.6",
+  "pymdownx-cjk-autojoin>=0.2.1",
+]
 
 [tool.pytest.ini_options]
 addopts = ["--cov=kabukit", "--cov-report=lcov:lcov.info", "--doctest-modules"]
@@ -95,7 +104,7 @@ skip_covered = true
 
 [tool.ruff]
 line-length = 88
-target-version = "py313"
+target-version = "py312"
 include = ["src/**/*.py", "tests/**/*.py"]
 
 [tool.ruff.lint]

{kabukit-0.7.6 → kabukit-0.8.1}/src/kabukit/__init__.py

@@ -1,17 +1,15 @@
+from .core.documents import Documents
 from .core.info import Info
-from .core.list import List
 from .core.prices import Prices
-from .core.reports import Reports
 from .core.statements import Statements
 from .edinet.client import EdinetClient
 from .jquants.client import JQuantsClient
 
 __all__ = [
+    "Documents",
     "EdinetClient",
     "Info",
     "JQuantsClient",
-    "List",
     "Prices",
-    "Reports",
     "Statements",
 ]

{kabukit-0.7.6 → kabukit-0.8.1}/src/kabukit/cli/auth.py

@@ -78,7 +78,7 @@ def show() -> None:
     from kabukit.utils.config import get_dotenv_path
 
     path = get_dotenv_path()
-    typer.echo(f"Configuration file: {path}")
+    typer.echo(f"設定ファイル: {path}")
 
     if path.exists():
         config = dotenv_values(path)

{kabukit-0.7.6 → kabukit-0.8.1}/src/kabukit/cli/cache.py

@@ -23,7 +23,9 @@ def add_to_tree(tree: Tree, path: Path) -> None:
             branch = tree.add(p.name)
             add_to_tree(branch, p)
         else:
-            tree.add(p.name)
+            size = p.stat().st_size
+            formatted_size = format_size(size)
+            tree.add(f"{p.name} ({formatted_size})")
 
 
 @app.command()
@@ -59,3 +61,13 @@ def clean() -> None:
         msg += "エラーが発生しました。"
         typer.secho(msg, fg=typer.colors.RED, bold=True)
         raise typer.Exit(1) from None
+
+
+def format_size(size_in_bytes: int) -> str:
+    if size_in_bytes < 1024:
+        return f"{size_in_bytes} B"
+
+    if size_in_bytes < 1024 * 1024:
+        return f"{size_in_bytes / 1024:.1f} KB"
+
+    return f"{size_in_bytes / (1024 * 1024):.1f} MB"

kabukit-0.8.1/src/kabukit/cli/get.py

@@ -0,0 +1,156 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Annotated, Any
+
+import typer
+from async_typer import AsyncTyper
+from typer import Argument, Option
+
+if TYPE_CHECKING:
+    from kabukit.core.base import Base
+
+# pyright: reportMissingTypeStubs=false
+# pyright: reportUnknownMemberType=false
+
+app = AsyncTyper(
+    add_completion=False,
+    help="J-Quantsからデータを取得します。",
+)
+
+Code = Annotated[
+    str | None,
+    Argument(help="銘柄コード。指定しない場合は全銘柄の情報を取得します。"),
+]
+Quiet = Annotated[
+    bool,
+    Option("--quiet", "-q", help="プログレスバーを表示しません。"),
+]
+
+
+@app.async_command()
+async def info(code: Code = None, *, quiet: Quiet = False) -> None:
+    """上場銘柄一覧を取得します。"""
+    from kabukit.core.info import Info
+    from kabukit.jquants.client import JQuantsClient
+
+    async with JQuantsClient() as client:
+        df = await client.get_info(code)
+
+    if code or not quiet:
+        typer.echo(df)
+
+    if code is None:
+        path = Info(df).write()
+        typer.echo(f"全銘柄の情報を '{path}' に保存しました。")
+
+
+async def _fetch(
+    code: str | None,
+    target: str,
+    cls: type[Base],
+    fetch_func_name: str,
+    message: str,
+    *,
+    quiet: bool = False,
+    **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
+
+    progress = None if quiet else tqdm.asyncio.tqdm
+
+    try:
+        df = await fetch_all(target, progress=progress, **kwargs)
+    except KeyboardInterrupt:
+        typer.echo("中断しました。")
+        raise typer.Exit(1) from None
+
+    if not quiet:
+        typer.echo(df)
+
+    path = cls(df).write()
+    typer.echo(f"全銘柄の{message}を '{path}' に保存しました。")
+
+
+@app.async_command()
+async def statements(code: Code = None, *, quiet: Quiet = False) -> None:
+    """財務情報を取得します。"""
+    from kabukit.core.statements import Statements
+
+    await _fetch(
+        code=code,
+        target="statements",
+        cls=Statements,
+        fetch_func_name="get_statements",
+        message="財務情報",
+        quiet=quiet,
+    )
+
+
+@app.async_command()
+async def prices(code: Code = None, *, quiet: Quiet = False) -> None:
+    """株価情報を取得します。"""
+    from kabukit.core.prices import Prices
+
+    await _fetch(
+        code=code,
+        target="prices",
+        cls=Prices,
+        fetch_func_name="get_prices",
+        message="株価情報",
+        quiet=quiet,
+        max_concurrency=8,
+    )
+
+
+@app.async_command()
+async def documents(*, quiet: Quiet = False) -> None:
+    """書類一覧を取得します。"""
+    import tqdm.asyncio
+
+    from kabukit.core.documents import Documents
+    from kabukit.edinet.concurrent import fetch_documents
+
+    progress = None if quiet else tqdm.asyncio.tqdm
+
+    try:
+        df = await fetch_documents(years=10, progress=progress)
+    except (KeyboardInterrupt, RuntimeError):
+        typer.echo("中断しました。")
+        raise typer.Exit(1) from None
+
+    if not quiet:
+        typer.echo(df)
+
+    path = Documents(df).write()
+    typer.echo(f"書類一覧を '{path}' に保存しました。")
+
+
+@app.async_command(name="all")
+async def all_(code: Code = None, *, quiet: Quiet = False) -> None:
+    """上場銘柄一覧、財務情報、株価情報、書類一覧を連続して取得します。"""
+    typer.echo("上場銘柄一覧を取得します。")
+    await info(code, quiet=quiet)
+
+    typer.echo("---")
+    typer.echo("財務情報を取得します。")
+    await statements(code, quiet=quiet)
+
+    typer.echo("---")
+    typer.echo("株価情報を取得します。")
+    await prices(code, quiet=quiet)
+
+    if code is None:
+        typer.echo("---")
+        typer.echo("書類一覧を取得します。")
+        await documents(quiet=quiet)

kabukit-0.7.6/src/kabukit/core/list.py → kabukit-0.8.1/src/kabukit/core/documents.py

@@ -3,5 +3,5 @@ from __future__ import annotations
 from .base import Base
 
 
-class List(Base):
+class Documents(Base):
     pass

kabukit-0.8.1/src/kabukit/edinet/__init__.py

@@ -0,0 +1,3 @@
+from .concurrent import fetch, fetch_csv, fetch_documents
+
+__all__ = ["fetch", "fetch_csv", "fetch_documents"]

{kabukit-0.7.6 → kabukit-0.8.1}/src/kabukit/edinet/client.py

@@ -14,7 +14,7 @@ from kabukit.core.client import Client
 from kabukit.utils.config import load_dotenv
 from kabukit.utils.params import get_params
 
-from .doc import clean_csv, clean_list, read_csv
+from .doc import clean_csv, clean_documents, read_csv
 
 if TYPE_CHECKING:
     import datetime
@@ -62,6 +62,15 @@ class EdinetClient(Client):
         return resp
 
     async def get_count(self, date: str | datetime.date) -> int:
+        """書類一覧 API を使い、特定の日付の提出書類数を取得する。
+
+        Args:
+            date (str | datetime.date): 取得対象の日付 (YYYY-MM-DD)
+
+        Returns:
+            int: 書類数
+
+        """
         params = get_params(date=date, type=1)
         resp = await self.get("/documents.json", params)
         data = resp.json()
@@ -72,7 +81,15 @@ class EdinetClient(Client):
 
         return metadata["resultset"]["count"]
 
-    async def get_list(self, date: str | datetime.date) -> DataFrame:
+    async def get_documents(self, date: str | datetime.date) -> DataFrame:
+        """書類一覧 API を使い、特定の日付の提出書類一覧を取得する。
+
+        Args:
+            date (str | datetime.date): 取得対象の日付 (YYYY-MM-DD)
+
+        Returns:
+            DataFrame: 提出書類一覧を格納した DataFrame
+        """
         params = get_params(date=date, type=2)
         resp = await self.get("/documents.json", params)
         data = resp.json()
@@ -85,7 +102,7 @@ class EdinetClient(Client):
         if df.is_empty():
             return df
 
-        return clean_list(df, date)
+        return clean_documents(df, date)
 
     async def get_document(self, doc_id: str, doc_type: int) -> Response:
         params = get_params(type=doc_type)

{kabukit-0.7.6 → kabukit-0.8.1}/src/kabukit/edinet/concurrent.py

@@ -52,7 +52,7 @@ async def fetch(
     )
 
 
-async def fetch_list(
+async def fetch_documents(
     days: int | None = None,
     years: int | None = None,
     limit: int | None = None,
@@ -60,11 +60,11 @@ async def fetch_list(
     progress: Progress | None = None,
     callback: Callback | None = None,
 ) -> DataFrame:
-    """過去days日またはyears年の文書一覧を取得し、単一のDataFrameにまとめて返す。
+    """過去 days 日または years 年の文書一覧を取得し、単一の DataFrame にまとめて返す。
 
     Args:
-        days (int | None): 過去days日の日付リストを取得する。
-        years (int | None): 過去years年の日付リストを取得する。
+        days (int | None): 過去 days 日の日付リストを取得する。
+        years (int | None): 過去 years 年の日付リストを取得する。
             daysが指定されている場合は無視される。
         max_concurrency (int | None, optional): 同時に実行するリクエストの最大数。
             指定しないときはデフォルト値が使用される。
@@ -84,13 +84,13 @@ async def fetch_list(
         dates = dates[:limit]
 
     df = await fetch(
-        "list",
+        "documents",
         dates,
         max_concurrency=max_concurrency,
         progress=progress,
         callback=callback,
     )
-    return df.sort("Date")
+    return df.sort("Date", "Code")
 
 
 async def fetch_csv(

{kabukit-0.7.6 → kabukit-0.8.1}/src/kabukit/edinet/doc.py

@@ -10,7 +10,7 @@ if TYPE_CHECKING:
     from polars import DataFrame
 
 
-def clean_list(df: DataFrame, date: str | datetime.date) -> DataFrame:
+def clean_documents(df: DataFrame, date: str | datetime.date) -> DataFrame:
     if isinstance(date, str):
         date = (
             datetime.datetime.strptime(date, "%Y-%m-%d")
@@ -35,7 +35,8 @@ def clean_list(df: DataFrame, date: str | datetime.date) -> DataFrame:
             pl.col("^.+Flag$").cast(pl.Int8).cast(pl.Boolean),
             pl.col("^.+Code$").cast(pl.String),
         )
-        .select("Date", pl.exclude("Date"))
+        .rename({"secCode": "Code"})
+        .select("Date", "Code", pl.exclude("Date", "Code"))
     )
 
 

{kabukit-0.7.6 → kabukit-0.8.1}/src/kabukit/jquants/info.py

@@ -15,6 +15,7 @@ async def get_target_codes() -> list[str]:
     """分析対象となる銘柄コードのリストを返す。
 
     以下の条件を満たす銘柄は対象外とする。
+
     - 市場: TOKYO PRO MARKET
     - 業種: その他 -- (投資信託など)
     - 優先株式

{kabukit-0.7.6 → kabukit-0.8.1}/src/kabukit/utils/concurrent.py

@@ -51,7 +51,7 @@ async def collect[R](
     tasks = {asyncio.create_task(run(awaitable)) for awaitable in awaitables}
 
     try:
-        async for future in asyncio.as_completed(tasks):
+        for future in asyncio.as_completed(tasks):  # async for (python 3.13+)
             with contextlib.suppress(asyncio.CancelledError):
                 yield await future
     finally: