bbstrader 0.3.5__py3-none-any.whl → 0.3.6__py3-none-any.whl

bbstrader/tseries.py

@@ -24,7 +24,6 @@ from statsmodels.tsa.vector_ar.var_model import VAR
 from statsmodels.tsa.vector_ar.vecm import coint_johansen
 from tqdm import tqdm
 
-
 __all__ = [
     "run_kalman_filter",
     "KalmanFilterModel",
@@ -746,32 +745,40 @@ def select_assets(df: pd.DataFrame, n=100, start=None, end=None, rolling_window=
 
 
 def compute_pair_metrics(security: pd.Series, candidates: pd.DataFrame):
-    """
-    Calculates statistical and econometric metrics for a target security and a set of candidate securities.
-    These metrics are useful in financial modeling and pairs trading strategies,
-    providing information about drift, volatility, correlation, and cointegration.
+    """Calculate statistical and econometric metrics for a security pair.
 
-    Args:
-        security (pd.Series): A time-series of the target security's prices.
-            The name of the Series should correspond to the security's identifier (e.g., ticker symbol).
-        candidates (pd.DataFrame): A DataFrame where each column represents a time-series of prices
-            for candidate securities to be evaluated against the target security.
+    These metrics are useful in financial modeling and pairs trading strategies,
+    providing information about drift, volatility, correlation, and
+    cointegration.
 
-    Returns:
-        pd.DataFrame: A DataFrame combining:
-            Drift: Estimated drift of spreads between the target security and each candidate.
-            Volatility: Standard deviation of spreads.
-            Correlation:
-                ``corr``: Correlation of normalized prices between the target and each candidate.
-                ``corr_ret``: Correlation of returns (percentage change) between the target and each candidate.
-            Cointegration metrics:
-                Engle-Granger test statistics (``t1``, ``t2``) and p-values (``p1``, ``p2``).
-                Johansen test trace statistics (``trace0``, ``trace1``) and selected lag order (``k_ar_diff``).
+    Parameters
+    ----------
+    security : pd.Series
+        A time-series of the target security's prices. The name of the
+        Series should correspond to the security's identifier (e.g., ticker
+        symbol).
+    candidates : pd.DataFrame
+        A DataFrame where each column represents a time-series of prices
+        for candidate securities to be evaluated against the target security.
+
+    Returns
+    -------
+    pd.DataFrame
+        A DataFrame containing the following metrics as columns:
+        * ``Drift``: Estimated drift of spreads.
+        * ``Volatility``: Standard deviation of spreads.
+        * ``corr``: Correlation of normalized prices.
+        * ``corr_ret``: Correlation of returns (percentage change).
+        * ``t1``, ``p1``: Engle-Granger test statistic and p-value.
+        * ``t2``, ``p2``: Engle-Granger test statistic and p-value (alternate form).
+        * ``trace0``, ``trace1``: Johansen test trace statistics.
+        * ``k_ar_diff``: Selected lag order for the Johansen test.
 
     References
     ----------
-    Stefan Jansen (2020). Machine Learning for Algorithmic Trading - Second Edition.
-    chapter 9, Time-Series Models for Volatility Forecasts and Statistical Arbitrage.
+    * [1] Jansen, S. (2020). Machine Learning for Algorithmic Trading -
+       Second Edition. Packt Publishing. Chapter 9, Time-Series Models
+       for Volatility Forecasts and Statistical Arbitrage.
     """
     security = security.div(security.iloc[0])
     ticker = security.name
@@ -834,102 +841,65 @@ def find_cointegrated_pairs(
     such as cointegration and Engle-Granger significance, to determine pairs suitable
     for financial strategies like pairs trading.
 
-    Args:
-        securities (`pd.DataFrame`): A DataFrame where each column represents the time-series
-            prices of target securities to evaluate.
-        candidates (`pd.DataFrame`): A DataFrame where each column represents the time-series
-            prices of candidate securities to compare against the target securities.
-        n (`int`, optional): The number of top pairs to return. If `None`, returns all pairs.
-        start (`str`, optional): Start date for slicing the data (e.g., 'YYYY-MM-DD').
-        stop (`str`, optional): End date for slicing the data (e.g., 'YYYY-MM-DD').
-        coint (`bool`, optional, default=False):
-            - If `True`, filters for pairs identified as cointegrated.
-            - If `False`, returns all evaluated pairs.
+    Parameters
+    ----------
+    securities : pd.DataFrame
+        A DataFrame where each column represents the time-series
+        prices of target securities to evaluate.
+    candidates : pd.DataFrame
+        A DataFrame where each column represents the time-series
+        prices of candidate securities to compare against the target securities.
+    n : int, optional
+        The number of top pairs to return. If ``None``, returns all pairs.
+    start : str, optional
+        Start date for slicing the data (e.g., 'YYYY-MM-DD').
+    stop : str, optional
+        End date for slicing the data (e.g., 'YYYY-MM-DD').
+    coint : bool, optional, default=False
+        If ``True``, filters for pairs identified as cointegrated.
+        If ``False``, returns all evaluated pairs.
+
+    Returns
+    -------
+    pd.DataFrame
+        A DataFrame containing:
+
+        **Johansen and Engle-Granger cointegration metrics**
+            * ``t1``, ``t2`` : Engle-Granger test statistics for two directions.
+            * ``p1``, ``p2`` : Engle-Granger p-values for two directions.
+            * ``trace0``, ``trace1`` : Johansen test trace statistics for 0 and 1 cointegration relationships.
+
+        **Indicators and filters**
+            * ``joh_sig`` : Indicates Johansen cointegration significance.
+            * ``eg_sig`` : Indicates Engle-Granger significance (p-value < 0.05).
+            * ``s1_dep`` : Indicates whether the first series depends on the second (based on p-values).
+            * ``coint`` : Combined cointegration indicator (Johansen & Engle-Granger).
+
+        **Spread and ranking**
+            * ``t`` : Minimum of ``t1`` and ``t2``.
+            * ``p`` : Minimum of ``p1`` and ``p2``.
 
-    Returns:
-        - ``pd.DataFrame``: A DataFrame containing:
-        - Johansen and Engle-Granger cointegration metrics:
-            - `t1`, `t2`: Engle-Granger test statistics for two directions.
-            - `p1`, `p2`: Engle-Granger p-values for two directions.
-            - `trace0`, `trace1`: Johansen test trace statistics for 0 and 1 cointegration relationships.
-        - Indicators and filters:
-            - `joh_sig`: Indicates Johansen cointegration significance.
-            - `eg_sig`: Indicates Engle-Granger significance (p-value < 0.05).
-            - `s1_dep`: Indicates whether the first series depends on the second (based on p-values).
-            - `coint`: Combined cointegration indicator (Johansen & Engle-Granger).
-        - Spread and ranking:
-            - `t`: Minimum of `t1` and `t2`.
-            - `p`: Minimum of `p1` and `p2`.
     References
     ----------
-    Stefan Jansen (2020). Machine Learning for Algorithmic Trading - Second Edition.
-    chapter 9, Time-Series Models for Volatility Forecasts and Statistical Arbitrage.
-
-    Example:
-    >>>    import pandas as pd
+    Stefan Jansen (2020). *Machine Learning for Algorithmic Trading - Second Edition*.
+    Chapter 9, Time-Series Models for Volatility Forecasts and Statistical Arbitrage.
 
-    >>>    # Sample Data
-    >>>    data_securities = {
-    ...        'Security1': [100, 102, 101, 103, 105],
-    ...        'Security2': [50, 52, 53, 51, 54]
-    ...    }
-    >>>    data_candidates = {
-    ...        'Candidate1': [100, 101, 99, 102, 104],
-    ...        'Candidate2': [200, 202, 201, 203, 205]
-    ...    }
-
-    >>>    securities = pd.DataFrame(data_securities, index=pd.date_range('2023-01-01', periods=5))
-    >>>    candidates = pd.DataFrame(data_candidates, index=pd.date_range('2023-01-01', periods=5))
-
-    >>>    # Find cointegrated pairs
-    >>>    top_pairs = find_cointegrated_pairs(securities, candidates, n=2, coint=True)
-    >>>    print(top_pairs)
-
-    >>>    | s1       | s2        | t    | p     | joh_sig | eg_sig | coint |
-    >>>    |----------|-----------|------|-------|---------|--------|-------|
-    >>>    | Security1| Candidate1| -3.5 | 0.01  | 1       | 1      | 1     |
-    >>>    | Security2| Candidate2| -2.9 | 0.04  | 1       | 1      | 1     |
+    Examples
+    --------
+    >>> import pandas as pd
+    >>> data_securities = {
+    ...     'Security1': [100, 102, 101, 103, 105],
+    ...     'Security2': [50, 52, 53, 51, 54]
+    ... }
+    >>> data_candidates = {
+    ...     'Candidate1': [100, 101, 99, 102, 104],
+    ...     'Candidate2': [200, 202, 201, 203, 205]
+    ... }
+    >>> securities = pd.DataFrame(data_securities, index=pd.date_range('2023-01-01', periods=5))
+    >>> candidates = pd.DataFrame(data_candidates, index=pd.date_range('2023-01-01', periods=5))
+    >>> top_pairs = find_cointegrated_pairs(securities, candidates, n=2, coint=True)
+    >>> print(top_pairs)
     """
-    trace0_cv = __CRITICAL_VALUES[0][
-        0.95
-    ]  # critical value for 0 cointegration relationships
-    # critical value for 1 cointegration relationship
-    trace1_cv = __CRITICAL_VALUES[1][0.95]
-    spreads = []
-    if start is not None and stop is not None:
-        securities = securities.loc[str(start) : str(stop), :]
-        candidates = candidates.loc[str(start) : str(stop), :]
-    for i, (ticker, prices) in enumerate(securities.items(), 1):
-        try:
-            df = compute_pair_metrics(prices, candidates)
-            spreads.append(df.set_index("s1", append=True))
-        except np.linalg.LinAlgError:
-            continue
-    spreads = pd.concat(spreads)
-    spreads.index.names = ["s2", "s1"]
-    spreads = spreads.swaplevel()
-    spreads["t"] = spreads[["t1", "t2"]].min(axis=1)
-    spreads["p"] = spreads[["p1", "p2"]].min(axis=1)
-    spreads["joh_sig"] = (
-        (spreads.trace0 > trace0_cv) & (spreads.trace1 > trace1_cv)
-    ).astype(int)
-    spreads["eg_sig"] = (spreads.p < 0.05).astype(int)
-    spreads["s1_dep"] = spreads.p1 < spreads.p2
-    spreads["coint"] = (spreads.joh_sig & spreads.eg_sig).astype(int)
-    # select top n pairs
-    if coint:
-        if n is not None:
-            top_pairs = (
-                spreads.query("coint == 1").sort_values("t", ascending=False).head(n)
-            )
-        else:
-            top_pairs = spreads.query("coint == 1").sort_values("t", ascending=False)
-    else:
-        if n is not None:
-            top_pairs = spreads.sort_values("t", ascending=False).head(n)
-        else:
-            top_pairs = spreads.sort_values("t", ascending=False)
-    return top_pairs
 
 
 def analyze_cointegrated_pairs(
@@ -1121,25 +1091,31 @@ def KFSmoother(prices: pd.Series | np.ndarray) -> pd.Series | np.ndarray:
 
 
 def KFHedgeRatio(x: pd.Series | np.ndarray, y: pd.Series | np.ndarray) -> np.ndarray:
-    """
-    Estimate Hedge Ratio using Kalman Filter.
-    Args:
-        x : pd.Series or np.ndarray
-            The independent variable, which can be either a pandas Series or a numpy array.
-        y : pd.Series or np.ndarray
-            The dependent variable, which can be either a pandas Series or a numpy array.
+    """Estimate Hedge Ratio using Kalman Filter.
 
-    Returns:
-        np.ndarray
-            The estimated hedge ratio as a numpy array.
+    This function uses a Kalman Filter to dynamically estimate the hedge ratio
+    (beta) and intercept (alpha) for a pair of assets over time.
 
-    The function returns the negative of the first state variable of each Kalman Filter estimate,
-    which represents the estimated hedge ratio.
+    The function returns the negative of the first state variable (the hedge ratio)
+    for each time step, which is a common convention in pairs trading.
+
+    Parameters
+    ----------
+    x : pd.Series or np.ndarray
+        The independent variable (e.g., price series of asset X).
+    y : pd.Series or np.ndarray
+        The dependent variable (e.g., price series of asset Y).
+
+    Returns
+    -------
+    np.ndarray
+        The time-varying estimated hedge ratio as a numpy array.
 
     References
     ----------
-    Stefan Jansen (2020). Machine Learning for Algorithmic Trading - Second Edition.
-    chapter 9, Time-Series Models for Volatility Forecasts and Statistical Arbitrage.
+    * [1] Jansen, S. (2020). Machine Learning for Algorithmic Trading -
+       Second Edition. Packt Publishing. Chapter 9, Time-Series Models
+       for Volatility Forecasts and Statistical Arbitrage.
     """
     if not isinstance(x, (np.ndarray, pd.Series)) or not isinstance(
         y, (np.ndarray, pd.Series)

{bbstrader-0.3.5.dist-info → bbstrader-0.3.6.dist-info}/METADATA

@@ -1,13 +1,12 @@
 Metadata-Version: 2.4
 Name: bbstrader
-Version: 0.3.5
+Version: 0.3.6
 Summary: Simplified Investment & Trading Toolkit
-Home-page: https://github.com/bbalouki/bbstrader
-Download-URL: https://pypi.org/project/bbstrader/
-Author: Bertin Balouki SIMYELI
-Author-email: <bertin@bbstrader.com>
-Maintainer: Bertin Balouki SIMYELI
-License: MIT
+Author-email: Bertin Balouki SIMYELI <bertin@bbstrader.com>
+Maintainer-email: Bertin Balouki SIMYELI <bertin@bbstrader.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/bbalouki/bbstrader
+Project-URL: Download, https://pypi.org/project/bbstrader/
 Project-URL: Documentation, https://bbstrader.readthedocs.io/en/latest/
 Project-URL: Source Code, https://github.com/bbalouki/bbstrader
 Keywords: Finance,Toolkit,Financial,Analysis,Fundamental,Quantitative,Database,Equities,Currencies,Economics,ETFs,Funds,Indices,Moneymarkets,Commodities,Futures,CFDs,Derivatives,Trading,Investing,Portfolio,Optimization,Performance
@@ -19,6 +18,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Operating System :: Microsoft :: Windows
 Classifier: Operating System :: POSIX :: Linux
 Classifier: Operating System :: MacOS
+Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: alphalens-reloaded>=0.4.6
@@ -58,21 +58,7 @@ Requires-Dist: vaderSentiment>=3.3.2
 Requires-Dist: yfinance>=0.2.65
 Provides-Extra: mt5
 Requires-Dist: MetaTrader5; extra == "mt5"
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: download-url
-Dynamic: home-page
-Dynamic: keywords
-Dynamic: license
 Dynamic: license-file
-Dynamic: maintainer
-Dynamic: project-url
-Dynamic: provides-extra
-Dynamic: requires-dist
-Dynamic: summary
 
 # Simplified Investment & Trading Toolkit
 [![Documentation Status](https://readthedocs.org/projects/bbstrader/badge/?version=latest)](https://bbstrader.readthedocs.io/en/latest/?badge=latest)

{bbstrader-0.3.5.dist-info → bbstrader-0.3.6.dist-info}/RECORD

@@ -1,10 +1,10 @@
-bbstrader/__init__.py,sha256=-5f30lprSg-ufbPbmj1J3P63elB--NPXo9_G_QuhWF0,581
-bbstrader/__main__.py,sha256=RjUIJWaD2_Od8ZMSLL8dzc2ZuCkkzlvNaE7-LIu3RGU,2488
+bbstrader/__init__.py,sha256=kUjCDqDwFaqgcJkaLrgRGiaTwyxG3iTTbOy8V3iefYk,747
+bbstrader/__main__.py,sha256=Cc3cSqHSCOdhk6gsg0lfL5TOaNz_ODXoe1wWgr_DewQ,2745
 bbstrader/compat.py,sha256=bHTPTalffQNVv7MNRPaimJ4d9rQEwQFLSovHlUbxNgA,647
 bbstrader/config.py,sha256=Q8xi6laFo-R-NNGotbHOgy8GLLuwvH6MaoiLhfTbYok,3548
-bbstrader/tseries.py,sha256=SM_LTQHJ3ZXVkVJyZ51CefUDzJDl2TkJqBKMp_uM8s4,43833
+bbstrader/tseries.py,sha256=fEIsG0kkMuG1TSrMnPK1u-tihzfFIOR675s18p3pg4A,41953
 bbstrader/apps/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-bbstrader/apps/_copier.py,sha256=z6GhLSmFjHc_oh7pYRTflH42Xmpe3Z7B2fUyedzDQPo,25387
+bbstrader/apps/_copier.py,sha256=wI33uEKEw8WElb4QA34UBbsXl4o7OqpjPSV023n_bb8,25393
 bbstrader/btengine/__init__.py,sha256=y1btjaEfhWsH8vuE7mBRpP9Tu-Azt9REhuVYsPCAfBU,2955
 bbstrader/btengine/backtest.py,sha256=o3eoCVzpjykDx-9VgkxK6DKZdGDAuLVeeWLCa2U_zeY,14652
 bbstrader/btengine/data.py,sha256=WcBLtabboZkQdtOQS3SjbiJD9BcWc75sdhZ2voQ_lUw,27061
@@ -13,7 +13,7 @@ bbstrader/btengine/execution.py,sha256=4MytWjcKg8J_w14P43emHqsvKOElkQTfhVYNakU6e
 bbstrader/btengine/performance.py,sha256=1ecWrTzHBQbk4ORvbTEKxwCzlL1brcXOEUwgbnjAwx4,12470
 bbstrader/btengine/portfolio.py,sha256=z98M65HQeCyma8gMZkAxspxBA9jtIhzxMyJUHPPj34c,16128
 bbstrader/btengine/scripts.py,sha256=8o66dq4Ex4DsH4s8xvJqUOFjLzZJSnbBvvNBzohtzoE,4837
-bbstrader/btengine/strategy.py,sha256=hDghr5sXNitWlWXXvgl8Vj-QHWaIuVlx54LUXAbQrHQ,36725
+bbstrader/btengine/strategy.py,sha256=6MR2atgXA4bkMQ9TE1lPr6P8vKAUoT0YoLmOFYEJiaA,39242
 bbstrader/core/__init__.py,sha256=GIFzFSStPfE0XM2j7mDeZZQeMTh_AwPsDOQXwMVJLgw,97
 bbstrader/core/data.py,sha256=5-ByClb-E3-iqDz8CBJ4om9wBIA7DmUWezu4A-tv5ys,25095
 bbstrader/core/scripts.py,sha256=7lNddfX7WaZfiE5dENEfzv3XrAPrwoE9FYSaTie3cwM,5524
@@ -21,29 +21,42 @@ bbstrader/core/utils.py,sha256=tHXQimmmlYZHktNnYNKn_wVq6v-85pI7DXF6xlJV7ps,2780
 bbstrader/ibkr/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bbstrader/ibkr/utils.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bbstrader/metatrader/__init__.py,sha256=A5Ye9tpc2sp9Xk5qjKw-EfYsoRcZtAt8nqvC3tCtZs8,333
-bbstrader/metatrader/account.py,sha256=Ur0vKz_puUP9jmdJUpvdQq6W5ue0RfnhkL0JLPBQkOE,65200
-bbstrader/metatrader/analysis.py,sha256=ywETmG3qxZ7ms_DCjR1GcQoUrQ0es5-n-CPDYKBAm8Q,3614
-bbstrader/metatrader/copier.py,sha256=RxXm_NKpaad4sMT1kuJNjeJcbP368asXLaAVqmoRfmE,55553
+bbstrader/metatrader/account.py,sha256=5YdvRggBxfZ6MQX70EFfwAZ7tuHvGzkwyEw1GgtiR4c,65501
+bbstrader/metatrader/analysis.py,sha256=HuxYiKwa7VYmI_noqc4OAKSoC7bJpYm-OosQGZdMEnU,3694
+bbstrader/metatrader/copier.py,sha256=VOo0RfuNoItc10CRGdX8MsUtcBBAzoY42sfolmvgptg,56052
 bbstrader/metatrader/rates.py,sha256=w9mr6FB6E1zLcHCDtDGt-oMnw6sakIU6Qe3455KDsSg,20782
 bbstrader/metatrader/risk.py,sha256=NhW8qtSg350Z6H9oLcDqOU_erqd_7Y7F5FwpfPN5Qso,27262
 bbstrader/metatrader/scripts.py,sha256=8meq6_zz6jPSibNgtYtaO8Ba-uJZOoLkpqYUIjidk-U,4010
-bbstrader/metatrader/trade.py,sha256=X6DNpPrHL0xQUAblJsCxmpSNWlFw8otEM1pWpgYTydE,81041
-bbstrader/metatrader/utils.py,sha256=PnFZ8EuBSZgsYlvwZDOxj4vUTtt-hUYnnwFBmu7gxxw,20738
+bbstrader/metatrader/trade.py,sha256=-tMbMBSTGAFJe9xK706uhR0Na8lJu7vfEhmud9Q3XnU,81003
+bbstrader/metatrader/utils.py,sha256=Yt3mx8EgS6u1-irQG6uQn-LhC3kyWOVE00VepnDAtCI,20802
 bbstrader/models/__init__.py,sha256=B-bn2h_SCK6gRAs2li6dDVnvV8jDT5suZimldk5xxcw,497
 bbstrader/models/factors.py,sha256=J7yxtDr1sCTw1AI59kluF89e2b9HkpEXfFyIcfPHUCQ,13008
 bbstrader/models/ml.py,sha256=NVN9zxRRDJn2S8KSgGBkiSHvdFjsDiaNsW2Y6rs51Io,50314
-bbstrader/models/nlp.py,sha256=hcvz9d_8j1cIC1h3oqa1DBjExRIEd6WSiZb95Vr3NPo,32638
+bbstrader/models/nlp.py,sha256=z_mbL58U5UGXc7ocVtvUR_zUYSk7Om2Gu7xXYBerxQY,32619
 bbstrader/models/optimization.py,sha256=Fa4tdhynMmvKt5KHV9cH1TXmmJVJwU4QWpYkbeVq4aI,6395
 bbstrader/models/portfolio.py,sha256=r-47Zrn2r7iKCHm5YVtwkbBJXAZGM3QYy-rXCWY9-Bg,8079
 bbstrader/models/risk.py,sha256=MKCk53HtGIcivrNzH8Ikm5KMs1rXhFT5zkorUf30PyQ,506
 bbstrader/trading/__init__.py,sha256=ycLyuuxN5SujqtzR9X0Q74UQfK93q2va-GGAXdr-KS8,457
-bbstrader/trading/execution.py,sha256=CYt4fageoqcpMFvdRH-jX4hexAGUiG_wE94i1qg7BFM,41479
+bbstrader/trading/execution.py,sha256=CPjOKvVFq8ZnANQrOtpakp64ZAhn-73Bu-D9UPCKUws,41832
 bbstrader/trading/scripts.py,sha256=Tf5q33WqqygjpIv43_8nA82VZ3GM0qgb4Ggo3fHJ_wg,5744
 bbstrader/trading/strategies.py,sha256=RZ6P4SfIyRW72v0OnPnrc4Hv8X00FdxR-_sD23xe_Pg,11756
 bbstrader/trading/utils.py,sha256=57dKF9dcRu04oU2VRqydRrzW39dCW2wlDWhVt-sZdRw,1857
-bbstrader-0.3.5.dist-info/licenses/LICENSE,sha256=ZwC_RqqGmOPBUiMDKqLyJZ5HBeHq53LpL7TMRzrJY8c,1094
-bbstrader-0.3.5.dist-info/METADATA,sha256=-FeMRpGJTL9HvVnWmNbhLiHlu0kYfb7wqqANfLzVrew,26910
-bbstrader-0.3.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-bbstrader-0.3.5.dist-info/entry_points.txt,sha256=0yDCbhbgHswOzJnY5wRSM_FjjyMHGvY7lJpSSVh0xtI,54
-bbstrader-0.3.5.dist-info/top_level.txt,sha256=Wwj322jZmxGZ6gD_TdaPiPLjED5ReObm5omerwlmZIg,10
-bbstrader-0.3.5.dist-info/RECORD,,
+bbstrader-0.3.6.dist-info/licenses/LICENSE,sha256=ZwC_RqqGmOPBUiMDKqLyJZ5HBeHq53LpL7TMRzrJY8c,1094
+docs/conf.py,sha256=q_Z8_iz-YDgHhe4PpCOAtvN5Q-2hHquliG07FDEXdjo,1686
+tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tests/engine/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+tests/engine/test_backtest.py,sha256=OmHimBp518BBv0Eg-t_cIrBXMzfiYOGki5FW7kqFeFs,2136
+tests/engine/test_data.py,sha256=jAVICMt4YTKF5PN6ZIxhQ9CuUjbw9_gIPAC4sNA9GsE,19907
+tests/engine/test_events.py,sha256=is3v3mtQVKFVNyn-xF4F7yuBGA5vqgunqsoFgNJeH0c,11755
+tests/engine/test_execution.py,sha256=Sk3d_Rl9T0GjArficd75hEeVyeB_7yOcTD8ltpN4UlY,7961
+tests/engine/test_portfolio.py,sha256=csKWO4W0xWn3obxuPRBFAUHHR60j-IZfAz5bv7Y_u9M,9872
+tests/metatrader/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tests/metatrader/test_account.py,sha256=UiAWP0IRd6a1kmA_pTcEuCZAJjtq0U_Q-PcOdd2l69A,68627
+tests/metatrader/test_rates.py,sha256=dc43jAvkZby9TMJcwkcaEvH21jQudk1D8KQxWLlAYoQ,10424
+tests/metatrader/test_risk_management.py,sha256=lMT0m7dmT3iWihTkEwpMoHdJPPWU3XJmqgCV4qKT-uw,31019
+tests/metatrader/test_trade.py,sha256=gMyinOOgVC2SOV8xLMIKqUTwqXbSUuDGnhSmspXK9cw,15177
+bbstrader-0.3.6.dist-info/METADATA,sha256=zPS1ez6FJWRlX70OAjC9tSNerd1GuQJP9Hxv4mzorgc,26693
+bbstrader-0.3.6.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+bbstrader-0.3.6.dist-info/entry_points.txt,sha256=0yDCbhbgHswOzJnY5wRSM_FjjyMHGvY7lJpSSVh0xtI,54
+bbstrader-0.3.6.dist-info/top_level.txt,sha256=raTnmqZJ2B3Mvrhy_fV9szurE9yVctrKHBLZ1NJ5vnU,21
+bbstrader-0.3.6.dist-info/RECORD,,

bbstrader-0.3.6.dist-info/top_level.txt

@@ -0,0 +1,3 @@
+bbstrader
+docs
+tests

docs/conf.py

@@ -0,0 +1,56 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+import os
+import sys
+from unittest.mock import MagicMock
+from importlib.metadata import version, PackageNotFoundError
+
+os.system('pip install ..')
+sys.path.insert(0, os.path.abspath('../bbstrader'))
+
+class Mock(MagicMock):
+    @classmethod
+    def __getattr__(cls, name):
+        return MagicMock()
+
+# List the mock modules to avoid import errors
+MOCK_MODULES = ['MetaTrader5', 'talib', 'posix']
+sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
+
+project = 'bbstrader'
+copyright = '2023 - 2025, Bertin Balouki SIMYELI'
+author = 'Bertin Balouki SIMYELI'
+
+try:
+    release = version("bbstrader")
+except PackageNotFoundError:
+    release = "unknown"
+version = ".".join(release.split('.')[:2])
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.napoleon',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.todo',
+]
+
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'sphinx_rtd_theme'
+html_static_path = ['_static']

tests/engine/__init__.py

@@ -0,0 +1 @@
+

tests/engine/test_backtest.py

@@ -0,0 +1,58 @@
+import unittest
+from unittest.mock import MagicMock
+from datetime import datetime
+from bbstrader.btengine.backtest import BacktestEngine
+
+
+class TestBacktestEngine(unittest.TestCase):
+    def setUp(self):
+        # Create mock classes with minimum expected interface
+        self.symbol_list = ['FAKE']
+        self.initial_capital = 100000.0
+        self.heartbeat = 0.0
+        self.start_date = datetime(2020, 1, 1)
+
+        self.mock_data_handler_cls = MagicMock()
+        self.mock_strategy_cls = MagicMock()
+        self.mock_execution_handler_cls = MagicMock()
+
+        # Mock data_handler instance
+        self.mock_data_handler = MagicMock()
+        self.mock_data_handler.continue_backtest = False
+        self.mock_data_handler.get_latest_bar_datetime.return_value = self.start_date
+        self.mock_data_handler.update_bars.return_value = None
+
+        # Strategy and portfolio mock
+        self.mock_strategy = MagicMock()
+        self.mock_strategy.check_pending_orders.return_value = None
+        self.mock_strategy.get_update_from_portfolio.return_value = None
+
+        self.mock_portfolio = MagicMock()
+        self.mock_portfolio.all_holdings = [{"Total": self.initial_capital}]
+        self.mock_portfolio.current_positions = {}
+        self.mock_portfolio.current_holdings = {}
+
+        self.mock_execution_handler = MagicMock()
+
+        # Bind mock return values
+        self.mock_data_handler_cls.return_value = self.mock_data_handler
+        self.mock_strategy_cls.return_value = self.mock_strategy
+        self.mock_execution_handler_cls.return_value = self.mock_execution_handler
+
+    def test_backtest_engine_runs(self):
+        engine = BacktestEngine(
+            self.symbol_list,
+            self.initial_capital,
+            self.heartbeat,
+            self.start_date,
+            self.mock_data_handler_cls,
+            self.mock_execution_handler_cls,
+            self.mock_strategy_cls,
+        )
+        engine.portfolio = self.mock_portfolio 
+
+        result = engine.simulate_trading()
+        self.assertTrue(hasattr(result, '__class__')) 
+        
+if __name__ == "__main__":
+    unittest.main()