BackcastPro 0.0.3__py3-none-any.whl → 0.0.5__py3-none-any.whl

BackcastPro/__init__.py

@@ -1,8 +1,15 @@
 """
-## マニュアル
+BackcastPro をご利用いただきありがとうございます。
 
-* [**クイックスタート ユーザーガイド**](../examples/Quick Start User Guide.py)
+インストール後のご案内（インストール済みユーザー向け）
 
+- ドキュメント総合トップ: https://botteryosuke.github.io/BackcastPro/
+- クイックスタート/チュートリアル: https://botteryosuke.github.io/BackcastPro/tutorial
+- APIリファレンス: https://botteryosuke.github.io/BackcastPro/api-reference
+- 高度な使い方: https://botteryosuke.github.io/BackcastPro/advanced-usage
+- トラブルシューティング: https://botteryosuke.github.io/BackcastPro/troubleshooting
+
+※ 使い始めはチュートリアル → 詳細はAPIリファレンスをご参照ください。
 """
 from .backtest import Backtest
 from .strategy import Strategy

BackcastPro/_broker.py

@@ -19,15 +19,32 @@ if TYPE_CHECKING:
 
 class _Broker:
     """
-    data
-    cash
-    spread
-    commission
-    margin
-    trade_on_close
-    hedging
-    exclusive_orders
-    index
+    バックテストにおける証券取引の実行、注文管理、ポジション管理、損益計算を担当します。
+    実際の証券会社のブローカー機能をシミュレートし、リアルな取引環境を提供します。
+    
+    Parameters
+    ----------
+    data : pd.DataFrame
+        取引対象の価格データ。Open, High, Low, Closeの列を持つ必要があります。
+    cash : float
+        初期現金残高。正の値である必要があります。
+    spread : float
+        ビッドアスクスプレッド（買値と売値の差）。取引コストとして使用されます。
+    commission : float or tuple or callable
+        手数料の設定方法：
+        - float: 相対手数料（例: 0.001 = 0.1%）
+        - tuple: (固定手数料, 相対手数料) の組み合わせ
+        - callable: カスタム手数料計算関数 (size, price) -> 手数料
+    margin : float
+        必要証拠金率（0 < margin <= 1）。レバレッジ = 1/margin として計算されます。
+    trade_on_close : bool
+        取引を終値で実行するかどうか。Trueの場合、次の始値ではなく現在の終値で取引します。
+    hedging : bool
+        ヘッジングモードの有効化。Trueの場合、反対方向のポジションを同時に保有できます。
+    exclusive_orders : bool
+        排他的注文モード。Trueの場合、新しい注文が前のポジションを自動的にクローズします。
+    index : pd.Index
+        時系列データのインデックス。エクイティカーブの記録に使用されます。
     """
     # Tips:
     # 関数定義における`*`の意味
@@ -150,6 +167,14 @@ class _Broker:
         margin_used = sum(trade.value / self._leverage for trade in self.trades)
         return max(0, self.equity - margin_used)
 
+    @property
+    def cash(self):
+        return self._cash
+
+    @property
+    def commission(self):
+        return self._commission
+
     def next(self):
         i = self._i = len(self._data) - 1
         self._process_orders()

BackcastPro/backtest.py

@@ -9,6 +9,7 @@ from typing import Optional, Tuple, Type, Union
 
 import numpy as np
 import pandas as pd
+from tqdm import tqdm # プログレスバー
 
 from ._broker import _Broker
 from ._stats import compute_stats
@@ -160,6 +161,10 @@ class Backtest:
         self._strategy = strategy
         self._results: Optional[pd.Series] = None
         self._finalize_trades = bool(finalize_trades)
+        
+        # 初期化パラメータを保存（実行後に振り返るため）
+        self._cash = cash
+        self._commission = commission
 
     def run(self) -> pd.Series:
         """
@@ -220,6 +225,9 @@ class Backtest:
 
         strategy.init()
 
+        # strategy.init()で加工されたdataを再登録
+        self._data = data
+        
         # インジケーターがまだ「ウォームアップ」中の最初の数本のキャンドルをスキップ
         # 少なくとも2つのエントリが利用可能になるように+1
         start = 1
@@ -228,7 +236,15 @@ class Backtest:
         # np.nan >= 3は無効ではない；Falseです。
         with np.errstate(invalid='ignore'):
 
-            for i in range(start, len(self._data)):
+            # プログレスバーを表示
+            progress_bar = tqdm(range(start, len(self._data)), 
+                              desc="バックテスト実行中", 
+                              unit="step",
+                              ncols=120,
+                              leave=True,
+                              dynamic_ncols=True)
+            
+            for i in progress_bar:
                 # 注文処理とブローカー関連の処理
                 data = self._data.iloc[:i]
                 try:
@@ -240,6 +256,14 @@ class Backtest:
                 # 次のティック、バークローズ直前
                 strategy._data = data
                 strategy.next()
+                
+                # プログレスバーの説明を更新（現在の日付を表示）
+                if hasattr(self._data.index, 'strftime') and i > 0:
+                    try:
+                        current_date = self._data.index[i-1].strftime('%Y-%m-%d')
+                        progress_bar.set_postfix({"日付": current_date})
+                    except:
+                        pass
             else:
                 if self._finalize_trades is True:
                     # 統計を生成するために残っているオープン取引をクローズ

BackcastPro/data/{datareader.py → JapanStock.py}

@@ -105,6 +105,9 @@ def DataReader(code: str,
             if col in df.columns:
                 df[col] = pd.to_numeric(df[col], errors='coerce')
         
+        # Add code column to the DataFrame
+        df['code'] = code
+        
         return df
         
     except requests.exceptions.RequestException as e:

BackcastPro/data/__init__.py

@@ -1,6 +1,6 @@
 """Data and utilities for testing."""
 
-from .datareader import DataReader, JapanStocks
+from .JapanStock import DataReader, JapanStocks
 
 
 TOYOTA = DataReader('72030')

BackcastPro/order.py

@@ -20,9 +20,6 @@ class Order:
     キャンセルして新しい注文を出してください。
 
     すべての出された注文は[取消注文まで有効]です。
-
-    [filled]: https://www.investopedia.com/terms/f/fill.asp
-    [Good 'Til Canceled]: https://www.investopedia.com/terms/g/gtc.asp
     """
     def __init__(self, broker: '_Broker',
                  size: float,

backcastpro-0.0.5.dist-info/METADATA

@@ -0,0 +1,62 @@
+Metadata-Version: 2.4
+Name: BackcastPro
+Version: 0.0.5
+Summary: トレーディング戦略のためのPythonバックテストライブラリ
+Author-email: botterYosuke <yosuke.sasazawa@gmail.com>
+Project-URL: Homepage, https://github.com/botterYosuke/BackcastPro/
+Project-URL: Issues, https://github.com/BackcastPro/BackcastPro/issues
+Project-URL: Logo, https://raw.githubusercontent.com/BackcastPro/BackcastPro/main/docs/img/logo.drawio.svg
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: License :: OSI Approved :: MIT License
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+# <img src="https://raw.githubusercontent.com/botterYosuke/BackcastPro/main/docs/img/logo.drawio.svg" alt="BackcastPro Logo" width="40" height="24"> BackcastPro
+
+トレーディング戦略のためのPythonバックテストライブラリ。
+
+## インストール（Windows）
+
+### PyPIから（エンドユーザー向け）
+
+```powershell
+py -m pip install BackcastPro
+```
+
+### 開発用インストール
+
+開発用に、リポジトリをクローンして開発モードでインストールします。
+
+```powershell
+git clone <repository-url>
+cd BackcastPro
+py -m venv .venv
+.\.venv\Scripts\Activate.ps1
+py -m pip install -e .
+py -m pip install -r requirements.txt
+```
+
+**開発モードインストール（py -m pip install -e .）**
+- プロジェクトを開発モードでインストールします
+- `src` ディレクトリが自動的に Python パスに追加されます
+
+## 使用方法
+
+```python
+from BackcastPro import Strategy, Backtest
+from BackcastPro.data import DataReader, JapanStocks
+
+# ここにトレーディング戦略の実装を記述
+```
+
+## ドキュメント
+
+- [ドキュメント一覧](https://github.com/botterYosuke/BackcastPro/blob/main/docs/index.md)
+
+## バグ報告 / サポート
+
+- バグ報告や要望は GitHub Issues へ
+- 質問は Discord コミュニティへ（[招待リンク](https://discord.gg/fzJTbpzE)）
+- 使い方はドキュメントをご参照ください
+

backcastpro-0.0.5.dist-info/RECORD

@@ -0,0 +1,14 @@
+BackcastPro/__init__.py,sha256=bjVAcDM_rMCxRUjtt3Mz-HTKTIRdcfiMeWfJZOrL2Qk,782
+BackcastPro/_broker.py,sha256=RSI4nOcUG24qfRYEiVI0niWjZ2jqr0RrFA12xVvLIvw,19877
+BackcastPro/_stats.py,sha256=Omcx4BgfddBvnmkYHn4b49TXqCgHYr9McKk46qMKNuM,7843
+BackcastPro/backtest.py,sha256=YL37lPtLK8pRwfLi1EaMThtMu7tz6JSRFLzevT653ik,15025
+BackcastPro/order.py,sha256=6-BkY0PbDaQnVuJ2Vb4pUczmMhlvTO0KmgJ7xb5Pu_M,5501
+BackcastPro/position.py,sha256=7G1fKrCLuW8QACN4mWNvR-6yrk_X9ERFLbqo97LKuX0,2236
+BackcastPro/strategy.py,sha256=KhVXH62QxivI_6C3-7CxjXPXMQ--VMOL3as2iHBGegw,7207
+BackcastPro/trade.py,sha256=8pDyIh96NmzPgEDkYB9h2lekHl3wdK6JeZ5Ix3y8wWQ,7162
+BackcastPro/data/JapanStock.py,sha256=lIyns7Hh7tbGudwOpZ6Dmqf6ucqY8i5VDPNTYyn6hhI,6235
+BackcastPro/data/__init__.py,sha256=3JFR9MCMMlKAaFwP9YGzp3bRnCkKdO5tyG4dpx9KDF4,126
+backcastpro-0.0.5.dist-info/METADATA,sha256=QKvEw7xq_Zwu1HO39jo6LCPjX0P6YzOgS4nl6_0Ylhg,2147
+backcastpro-0.0.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+backcastpro-0.0.5.dist-info/top_level.txt,sha256=GiP-TX_Bc2jjwHS9cx0VCrW27e9JPbhWWnqGxa5B4Fs,12
+backcastpro-0.0.5.dist-info/RECORD,,

backcastpro-0.0.3.dist-info/METADATA

@@ -1,59 +0,0 @@
-Metadata-Version: 2.4
-Name: BackcastPro
-Version: 0.0.3
-Summary: トレーディング戦略のためのPythonバックテストライブラリ
-Author-email: botterYosuke <yosuke.sasazawa@gmail.com>
-Project-URL: Homepage, https://BackcastPro.github.io/BackcastPro/
-Project-URL: Issues, https://github.com/BackcastPro/BackcastPro/issues
-Project-URL: Logo, https://raw.githubusercontent.com/BackcastPro/BackcastPro/main/docs/img/logo.png
-Classifier: Programming Language :: Python :: 3
-Classifier: Operating System :: OS Independent
-Classifier: License :: OSI Approved :: MIT License
-Requires-Python: >=3.9
-Description-Content-Type: text/markdown
-
-# BackcastPro
-
-トレーディング戦略のためのPythonバックテストライブラリ。
-
-## インストール
-
-### PyPIから（エンドユーザー向け）
-
-```bash
-pip install BackcastPro
-```
-
-### 開発用インストール
-
-開発用に、リポジトリをクローンして開発モードでインストールしてください：
-
-```bash
-git clone <repository-url>
-cd BackcastPro
-pip install -e .
-```
-
-**開発モードインストール（pip install -e .）**
-- 上記で実行したpip install -e .コマンドは、プロジェクトを開発モードでインストールしました
-- これにより、srcディレクトリが自動的にPythonパスに追加されます
-
-## 使用方法
-
-```python
-from BackcastPro import Strategy, Backtest
-from BackcastPro.lib import resample_apply
-
-# ここにトレーディング戦略の実装を記述
-```
-
-## ドキュメント
-
-- [PyPIへのデプロイ方法](./docs/How%20to%20deploy%20to%20PyPI.md)
-- [サンプル](./docs/examples/)
-
-## バグ報告
-
-バグを報告したり、[ディスカッションボード](https://discord.gg/fzJTbpzE)に投稿する前に、
-
-

backcastpro-0.0.3.dist-info/RECORD

@@ -1,14 +0,0 @@
-BackcastPro/__init__.py,sha256=1PPRDL8uh_fE35shzswg3f1XrqVMNBJ1N6H7ZTqSzPg,191
-BackcastPro/_broker.py,sha256=5n6SR9wqEZz2s68iIrp7x3v7vhh6zL8ichfoYZPsquA,18191
-BackcastPro/_stats.py,sha256=Omcx4BgfddBvnmkYHn4b49TXqCgHYr9McKk46qMKNuM,7843
-BackcastPro/backtest.py,sha256=jcLzq9kOFYpm0u3FdXen92kPfKxdMkM4COVS9pbc_kA,13947
-BackcastPro/order.py,sha256=JuPJah6Mcm4Qr0wzOCex4hTmqXU96HGGRDiIl7_rsiQ,5636
-BackcastPro/position.py,sha256=7G1fKrCLuW8QACN4mWNvR-6yrk_X9ERFLbqo97LKuX0,2236
-BackcastPro/strategy.py,sha256=KhVXH62QxivI_6C3-7CxjXPXMQ--VMOL3as2iHBGegw,7207
-BackcastPro/trade.py,sha256=8pDyIh96NmzPgEDkYB9h2lekHl3wdK6JeZ5Ix3y8wWQ,7162
-BackcastPro/data/__init__.py,sha256=qSf674-OW7fQj48y6VqJW3Y_fSqwj9pAGhFS2u_s5ik,126
-BackcastPro/data/datareader.py,sha256=dhJ6BBmj713rD_Ks8mKm2o1MiLf4uG3YwS3xnEb1_cw,6154
-backcastpro-0.0.3.dist-info/METADATA,sha256=P-fyxj4jZWfnpIAYbQUmI1T0Eq-ZwsdEd3lWFmY9_wQ,1848
-backcastpro-0.0.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-backcastpro-0.0.3.dist-info/top_level.txt,sha256=GiP-TX_Bc2jjwHS9cx0VCrW27e9JPbhWWnqGxa5B4Fs,12
-backcastpro-0.0.3.dist-info/RECORD,,