Skip to main content

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.9 or later
  • pass (パスワード管理ツール: 認証情報の管理に利用)
  • Git (ソースからのインストール時)

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

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

このツールは、EDINET等のAPIキーの管理にパスワードマネージャー (pass) を使用します。 事前に各公式サイト(J-Quants / EDINET DB)等でキーを取得し、pass コマンドで登録してください

# J-Quants API キーの登録
pass insert jpx-jquants.com/api/JPX_JQUANTS_API_KEY
# EDINET DB API キーの登録
pass insert ednetdb/api/EDNET_DB_API_KEY

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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kabutam-0.1.6.tar.gz (31.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kabutam-0.1.6-py3-none-any.whl (35.9 kB view details)

Uploaded Python 3

File details

Details for the file kabutam-0.1.6.tar.gz.

File metadata

  • Download URL: kabutam-0.1.6.tar.gz
  • Upload date:
  • Size: 31.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for kabutam-0.1.6.tar.gz
Algorithm Hash digest
SHA256 4f915487d8d6044e65e1daf44072fbe1467c8b838bce4cf0ad7db73407fefe57
MD5 6d47118b11d90ddab4aaed01d3744f72
BLAKE2b-256 abdc4045f6aa5424e582b288903897b54f31ffdc11e619727a15d0eff28f659e

See more details on using hashes here.

Provenance

The following attestation bundles were made for kabutam-0.1.6.tar.gz:

Publisher: release.yml on tonrl/kabutam

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file kabutam-0.1.6-py3-none-any.whl.

File metadata

  • Download URL: kabutam-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 35.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for kabutam-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 6e63f2619495a986dedbcb817ba9f44784aea351e3578a1db5e7a88a4fdad457
MD5 0e452c875eed675a89ea856caacab296
BLAKE2b-256 4772be112dc06980ed1662bf383bb0737ee7f5f0a13e1ab9a41711544b8ee1a9

See more details on using hashes here.

Provenance

The following attestation bundles were made for kabutam-0.1.6-py3-none-any.whl:

Publisher: release.yml on tonrl/kabutam

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.1.9

2 files

0.1.8

2 files

0.1.7

2 files

This release

0.1.6 This release

2 files

0.1.4

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page