kabutam

Terminal-based stock and portfolio tracking tool for Japanese stocks.

Features

• Fetch and manage Japanese stock data
• Track your portfolio directly from the terminal
• Lightweight and easy to use

Prerequisites

• Python 3.11 or later
• Git (ソースからのインストール時)
• pass (pass を使用する場合)
• libsecret (secret-tool) (Secret Serviceを使用する場合)

Installation

For Arch Linux (via AUR)

AUR ヘルパーを使用する場合 (推奨)

yay -S kabutam
# または
paru -S kabutam

PKGBUILDからビルドする場合

git clone https://aur.archlinux.org/kabutam.git
cd kabutam
makepkg -si

PyPIからのインストール

pip install kabutam

For Development (Virtual Environment)

git clone https://codeberg.org/tonrl/kabutam.git
cd kabutam
python -m venv .venv
source .venv/bin/activate
pip install -e .

Configuration

Kabutamでは、EDINET DBやJ-QuantsなどのAPIキーを secret backend を使用して管理します。

デフォルトでは pass を使用しますが、D-Bus Secret Service APIに対応したパスワードマネージャーも利用できます。

事前に各公式サイト（J-Quants / EDINET DB）等でAPIキーを取得し、選択したsecret backend に登録してください

pass (デフォルト)

J-QuantsおよびEDINET DBのAPIキーを取得し、pass に登録してください。

APIキーの登録

J-Quants API キーの登録

pass insert jpx-jquants.com/api/JPX_JQUANTS_API_KEY

EDINET DB API キーの登録

pass insert ednetdb/api/EDNET_DB_API_KEY

設定ファイルを作成しない場合、pass がデフォルトで使用されます。

Secret Service対応パスワードマネージャー

pass の代わりに、D-Bus Secret Service APIに対応した パスワードマネージャーを利用できます。

対応例:

• KeePassXC
• GNOME Keyring
• KWallet Kabutam はこれらのパスワードマネージャーと直接連携するのではなく、D-Bus Secret Service APIを通じてsecretを取得します。

APIキーの登録

J-Quants API キーの登録

secret-tool store \
    --label="Kabutam J-Quants API Key" \
    service kabutam \
    username JPX_JQUANTS_API_KEY

EDINET DB API キーの登録

secret-tool store \
    --label="Kabutam EDINET DB API Key" \
    service kabutam \
    username EDNET_DB_API_KEY

Secret Serviceを使用する場合は、Kabutamの設定ファイルでSecret Service backendを選択してください。

Configuration file

設定ファイルはXDG Base Directory Specificationに従い、通常は以下に配置されます。

~/.config/kabutam/config.toml

[secrets]
backend = "secretservice"

[secrets.secretservice]
service = "kabutam"

service の値はSecret Serviceに登録した service 属性と一致している必要があります。

Usage

# ヘルプの表示
kabutam --help

# 初期化設定
kabutam --init

# 銘柄の検索・表示
kabutam -C 19670

# ポートフォリオ表示
kabutam --portfolio

# ライセンス情報の表示
kabutam --license

Example output

$ kabutam --portfolio                                                                       7:48 ✔ 
===============================================================================================
ポートフォリオ
===============================================================================================
Code    Company                 Account      Shares     Avg Price         Price           Value
-----------------------------------------------------------------------------------------------
XXXXX   サンプルホールディングス 特定         1,200        190.47        233.80         280,560
XXXXX   テストカンパニー         特定           100      2,401.75      3,002.00         300,200
XXXXX   テストカンパニー         NISA           100      2,300.00      3,002.00         300,200
XXXXX   サンプル電鉄             特定           100      2,708.00      2,959.50         295,950
XXXXX   サンプル通信             NISA           100        144.00        166.10          16,610
-----------------------------------------------------------------------------------------------
取得総額       : 1,292,520 円
保有資産額     : 1,392,520 円
評価損益       : +100,000 円
評価損益率     : +7.74%
===============================================================================================
年間配当金（税引前）: 45,000 円
年間配当金（税引後）: 35,858 円
配当利回り（取得額ベース）: 3.48%
配当利回り（評価額ベース）: 3.23%
===============================================================================================

License

This project is licensed under the GNU General Public License v3.0 or later - see the LICENSE file for details.