bbstrader 2.0.0__tar.gz → 2.0.2__tar.gz

bbstrader-2.0.2/PKG-INFO

@@ -0,0 +1,394 @@
+Metadata-Version: 2.4
+Name: bbstrader
+Version: 2.0.2
+Summary: Simplified Investment & Trading Toolkit with Python & C++
+Keywords: Finance,Toolkit,Financial,Analysis,Fundamental,Quantitative,Database,Equities,Currencies,Economics,ETFs,Funds,Indices,Moneymarkets,Commodities,Futures,CFDs,Derivatives,Trading,Investing,Portfolio,Optimization,Performance
+Author-Email: Bertin Balouki SIMYELI <bertin@bbs-trading.com>
+Maintainer-Email: Bertin Balouki SIMYELI <bertin@bbs-trading.com>
+License-Expression: MIT
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Office/Business :: Financial :: Investment
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS
+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
+Requires-Python: >=3.12
+Requires-Dist: beautifulsoup4>=4.13.5
+Requires-Dist: colorama>=0.4.6
+Requires-Dist: dash>=3.2.0
+Requires-Dist: eodhd>=1.0.32
+Requires-Dist: exchange_calendars>=4.11.1
+Requires-Dist: financetoolkit>=2.0.4
+Requires-Dist: ipython>=9.5.0
+Requires-Dist: nltk>=3.9.1
+Requires-Dist: notify_py>=0.3.43
+Requires-Dist: numpy>=2.2.6
+Requires-Dist: praw>=7.8.1
+Requires-Dist: pybind11>=3.0.1
+Requires-Dist: pyfiglet>=1.0.4
+Requires-Dist: pyportfolioopt>=1.5.6
+Requires-Dist: python-dotenv>=1.1.1
+Requires-Dist: python-telegram-bot>=22.3
+Requires-Dist: PyYAML>=6.0.2
+Requires-Dist: QuantStats>=0.0.77
+Requires-Dist: seaborn>=0.13.2
+Requires-Dist: spacy>=3.8.11
+Requires-Dist: sumy>=0.11.0
+Requires-Dist: tabulate>=0.9.0
+Requires-Dist: textblob>=0.19.0
+Requires-Dist: tweepy>=4.16.0
+Requires-Dist: vaderSentiment>=3.3.2
+Requires-Dist: yfinance>=0.2.65
+Provides-Extra: mt5
+Requires-Dist: MetaTrader5; extra == "mt5"
+Description-Content-Type: text/markdown
+
+# Simplified Investment & Trading Toolkit with Python & C++
+
+[![Documentation Status](https://readthedocs.org/projects/bbstrader/badge/?version=latest)](https://bbstrader.readthedocs.io/en/latest/?badge=latest)
+[![PYPI Version](https://img.shields.io/pypi/v/bbstrader)](https://pypi.org/project/bbstrader/)
+[![PyPi status](https://img.shields.io/pypi/status/bbstrader.svg?maxAge=60)](https://pypi.python.org/pypi/bbstrader)
+[![Supported Python Versions](https://img.shields.io/pypi/pyversions/bbstrader)](https://pypi.org/project/bbstrader/)
+[![Linux](https://github.com/bbalouki/bbstrader/actions/workflows/cpp_linux.yml/badge.svg)](https://github.com/bbalouki/bbstrader/actions/workflows/cpp_linux.yml)
+[![macOS](https://github.com/bbalouki/bbstrader/actions/workflows/cpp_macos.yml/badge.svg)](https://github.com/bbalouki/bbstrader/actions/workflows/cpp_macos.yml)
+[![Windows](https://github.com/bbalouki/bbstrader/actions/workflows/cpp_win.yml/badge.svg)](https://github.com/bbalouki/bbstrader/actions/workflows/cpp_win.yml)
+[![C++20](https://img.shields.io/badge/C++-20-blue.svg)](https://isocpp.org/std/the-standard)
+[![CMake](https://img.shields.io/badge/CMake-3.20+-blue.svg)](https://cmake.org/)
+[![PyPI Downloads](https://static.pepy.tech/badge/bbstrader)](https://pepy.tech/projects/bbstrader)
+[![CodeFactor](https://www.codefactor.io/repository/github/bbalouki/bbstrader/badge)](https://www.codefactor.io/repository/github/bbalouki/bbstrader)
+[![LinkedIn](https://img.shields.io/badge/LinkedIn-grey?logo=Linkedin&logoColor=white)](https://www.linkedin.com/in/bertin-balouki-s-15b17a1a6)
+
+## Welcome to `bbstrader` – The Ultimate C++ & Python Trading Powerhouse!
+
+## Table of Contents
+
+- [Overview](#overview)
+- [Why `bbstrader` Stands Out](#why-bbstrader-stands-out)
+- [Trusted by Traders Worldwide](#trusted-by-traders-worldwide)
+- [The `bbstrader` Edge: Uniting C++ Speed with Python Flexibility](#the-bbstrader-edge-uniting-c-speed-with-python-flexibility)
+  - [Overcoming the MQL5 Bottleneck](#overcoming-the-mql5-bottleneck)
+- [Key Modules](#key-modules)
+  - [1. `btengine`: Event-Driven Backtesting Beast](#1-btengine-event-driven-backtesting-beast)
+  - [2. `metatrader`: The C++/Python Bridge to MT5](#2-metatrader-the-cpython-bridge-to-mt5)
+    - [Pattern 1: C++ Core, Python Orchestrator (Maximum Performance)](#pattern-1-c-core-python-orchestrator-maximum-performance)
+    - [Pattern 2: Python-Driven with C++ Acceleration](#pattern-2-python-driven-with-c-acceleration)
+  - [3. `trading`: Live Execution & Strategy Orchestrator](#3-trading-live-execution--strategy-orchestrator)
+  - [4. `models`: Quant Toolkit for Signals & Risk](#4-models-quant-toolkit-for-signals--risk)
+- [Getting Started](#getting-started)
+  - [Prerequisites](#prerequisites)
+- [Installation](#installation)
+  - [For the Python Quant](#for-the-python-quant)
+  - [For the C++ Developer](#for-the-c-developer)
+- [CLI workflow](#cli-workflow)
+- [Community & Support](#-community--support)
+- [Professional Services](#professional-services)
+
+### Overview
+
+Imagine having the raw, blistering speed of C++ for your high-frequency trades, combined with Python's ecosystem for lightning-fast prototyping, advanced AI models, and seamless data analysis. That's `bbstrader` – not just a library, but a game-changing toolkit designed for quants, algo traders, and institutional pros who demand an edge in volatile markets. Whether you're scalping forex pairs, backtesting complex strategies, or copying trades across accounts in real-time, `bbstrader` empowers you to build, test, and deploy with unmatched efficiency.
+
+Forget the frustrations of slow Python bottlenecks or MQL5's rigid sandbox. `bbstrader` bridges worlds: C++ for mission-critical performance and Python for intelligent orchestration. It's open-source, battle-tested across platforms, and ready to supercharge your trading arsenal.
+
+## **Why `bbstrader` Stands Out**
+
+In a crowded field of trading libraries, `bbstrader` is architected to solve the most challenging problems in algorithmic trading: performance, flexibility, and platform limitations.
+
+- **Blazing Speed with C++ Core**: Compile your strategy logic in native C++ for deterministic, low-latency execution. Perfect for HFT, arbitrage, or compute-heavy models that Python alone can't handle.
+- **Python's Powerhouse Ecosystem**: Leverage `NumPy`, `pandas`, `scikit-learn`, `TensorFlow`, and more for research, ML-driven signals, and backtesting – all seamlessly integrated with your C++ core.
+- **Institutional-Grade Architecture:** From its event-driven backtester to its modular design, `bbstrader` is built with the principles of professional trading systems in mind, providing a robust foundation for serious strategy development.
+  In today's hyper-fast financial landscape, every microsecond counts. `bbstrader` isn't another lightweight wrapper – it's an institutional-grade powerhouse engineered to tackle real-world trading challenges head-on.
+- **Break Free from MQL5 Limits**: Ditch interpreted code and ecosystem constraints. Build multi-threaded, AI-infused strategies that execute orders in microseconds via MetaTrader 5 (MT5) integration.
+  **Flexible Interface**: CLI & GUI
+  `bbstrader` adapts to your workflow.
+  - **Automation Fanatics**: Use the CLI for headless scripts, cron jobs, and server deployments.
+  - **Visual Traders**: Launch the Desktop GUI (currently for Copy Trading) to monitor your master and slave accounts, check replication status, and manage connections visually.
+  - **Cross-Platform & Future-Proof**: Works on Windows, macOS, Linux. (IBKR integration in development).
+
+## **Trusted by Traders Worldwide**
+
+With thousands of downloads, `bbstrader` is trusted by traders worldwide. It's not just code – it's your ticket to profitable, scalable strategies.
+
+## **The `bbstrader` Edge: Uniting C++ Speed with Python Flexibility**
+
+bbstrader's hybrid design is its secret weapon. At the heart is a bidirectional C++/Python bridge via `metatrader_client` module:
+
+1. **C++ for Speed**: Core classes like `MetaTraderClient` handle high-performance tasks. Inject Python handlers for MT5 interactions, enabling native-speed signal generation and risk checks.
+2. **Python for Smarts**: Orchestrate everything with modules like `trading` and `btengine`.
+3. **The Data Flow:** The result is a clean, efficient, and powerful execution loop:
+   `Python (Orchestration & Analysis) -> C++ (High-Speed Signal Generation) -> Python (MT5 Communication) -> C++ (Receives Market Data)`
+
+This setup crushes performance ceilings: Run ML models in Python, execute trades in C++, and backtest millions of bars in minutes.
+
+### **Overcoming the MQL5 Bottleneck**
+
+MetaTrader 5 is a world-class trading platform, but its native MQL5 language presents significant limitations for complex, high-frequency strategies:
+
+- **Performance Ceilings:** As an interpreted language, MQL5 struggles with the computationally intensive logic required for advanced statistical models, machine learning, and rapid-fire order execution.
+- **Ecosystem Constraints:** MQL5 lacks access to the vast, mature ecosystems of libraries for numerical computation, data science, and AI that C++ and Python offer.
+- **Architectural Rigidity:** Implementing sophisticated, multi-threaded, or event-driven architectures in MQL5 is often a complex and error-prone endeavor.
+
+`bbstrader` eradicates these barriers. By moving your core strategy logic to C++, you can unlock the full potential of your trading ideas, executing them with the microsecond-level precision demanded by institutional trading.
+
+## **Key Modules**
+
+bbstrader is modular, with each component laser-focused.
+
+### 1. **btengine**: Event-Driven Backtesting Beast
+
+- **Purpose**: Simulate strategies with historical data, including slippage, commissions, and multi-asset portfolios. Optimizes parameters and computes metrics like Sharpe Ratio, Drawdown, and CAGR.
+- **Features**: Event queue for ticks/orders, vectorized operations for speed, integration with models for signal generation.
+- **Example**: Backtest a StockIndexSTBOTrading from the example strategies.
+
+```Python
+# Inside the examples/
+from strategies import test_strategy
+if __name__ == '__main__':
+    # Run backtesting for Stock Index Short Term Buy Only Strategy
+    test_strategy(strategy='sistbo')
+```
+
+### Backtesting Results
+
+![Backtesting Results1](https://github.com/bbalouki/bbstrader/blob/main/bbstrader/assets/bbs_.png?raw=true)
+![Backtesting Results2](https://github.com/bbalouki/bbstrader/blob/main/bbstrader/assets/qs_metrics_1.png?raw=true)
+
+### 2. **metatrader**: The C++/Python Bridge to MT5
+
+- **Purpose**: High-speed MT5 integration. C++ MetaTraderClient mirrors MT5 API for orders, rates, and account management.
+- **Features**: Bidirectional callbacks, error handling, real-time tick processing.
+- **Strategy Patterns**: Two main patterns to build strategies:
+
+#### Pattern 1: C++ Core, Python Orchestrator (Maximum Performance)
+
+This is the recommended pattern for latency-sensitive strategies, such as statistical arbitrage, market making, or any strategy where execution speed is a critical component of your edge. By compiling your core logic, you minimize interpretation overhead and gain direct control over memory and execution.
+
+**Use this pattern when:**
+
+- Your strategy involves complex mathematical calculations that are slow in Python.
+- You need to react to market data in the shortest possible time.
+- Your production environment demands deterministic, low-latency performance.
+
+**C++ Side (`MovingAverageStrategy.cpp`):**
+
+```cpp
+#include "bbstrader/metatrader.hpp"
+#include <numeric>
+#include <iostream>
+
+class MovingAverageStrategy : public MT5::MetaTraderClient {
+public:
+    using MetaTraderClient::MetaTraderClient;
+
+    void on_tick(const std::string& symbol) {
+        auto rates_opt = copy_rates_from_pos(symbol, 1, 0, 20);
+
+        if (!rates_opt || rates_opt->size() < 20) return;
+
+        const auto& rates = *rates_opt;
+
+        double sum = std::accumulate(rates.begin(), rates.end(), 0.0,
+                                     [](double a, const MT5::RateInfo& b) { return a + b.close; });
+        double sma = sum / rates.size();
+        double current_price = rates.back().close;
+
+        if (current_price > sma) {
+            std::cout << "Price is above SMA. Sending Buy Order for " << symbol << '\n';
+            MT5::TradeRequest request;
+            request.action = MT5::TradeAction::DEAL;
+            request.symbol = symbol;
+            request.volume = 0.1;
+            request.type = MT5::OrderType::BUY;
+            request.type_filling = MT5::OrderFilling::FOK;
+            request.type_time = MT5::OrderTime::GTC;
+            send_order(request);
+        }
+    }
+};
+```
+
+_This C++ class would then be exposed to Python using `pybind11`._
+
+```cpp
+// Inside bindings.cpp
+#include <pybind11/pybind11.h>
+#include "MovingAverageStrategy.hpp"
+
+namespace py = pybind11;
+
+PYBIND11_MODULE(my_strategies, m){
+py::class_<MovingAverageStrategy, MT5::MetaTraderClient>(m, "MovingAverageStrategy")
+    .def(py::init<MT5::MetaTraderClient::Handlers>())
+    .def("on_tick", &MovingAverageStrategy::on_tick);
+}
+```
+
+**Python Side (`main.py`):**
+
+```python
+from bbstrader.api import Mt5Handlers
+import MetaTrader5 as mt5
+import time
+from my_strategies import MovingAverageStrategy
+
+# 1. Instantiate the C++ strategy, injecting the Python MT5 handlers
+strategy = MovingAverageStrategy(Mt5Handlers)
+
+# 2. Main execution loop
+if strategy.initialize():
+    while True:
+        strategy.on_tick("EURUSD")
+        time.sleep(1)
+```
+
+#### Pattern 2: Python-Driven with C++ Acceleration
+
+This pattern is ideal for strategies that benefit from Python's rich ecosystem for data analysis, machine learning, or complex event orchestration, but still require high-performance access to market data and the trading API.
+
+**Use this pattern when:**
+
+- Your strategy relies heavily on Python libraries like `pandas`, `scikit-learn`, or `tensorflow`.
+- Rapid prototyping and iteration are more important than absolute minimum latency.
+- Your core logic is more about decision-making based on pre-processed data than it is about raw computation speed.
+
+```python
+import MetaTrader5 as mt5
+from bbstrader.api import Mt5Handlers
+from bbstrader.api.metatrader_client import MetaTraderClient
+
+# 1. Inherit from the C++ MetaTraderClient in Python
+class MyStrategyClient(MetaTraderClient):
+    def __init__(self, handlers):
+        super().__init__(handlers)
+
+# 2. Instantiate your client
+strategy = MyStrategyClient(Mt5Handlers)
+
+# 3. Interact with the MT5 terminal via the C++ bridge
+if strategy.initialize():
+    rates = strategy.copy_rates_from_pos("EURUSD", mt5.TIMEFRAME_M1, 0, 100)
+    print(f"Retrieved {len(rates)} rates via the C++ bridge.")
+```
+
+### 3. **`trading`: Live Execution & Strategy Orchestrator**
+
+- **Purpose**: Manages live sessions, coordinates signals from strategies, risk from models, and execution via metatrader.
+- **Features**: Multi-account support, position hedging, trailing stops.
+
+### 4. `models`: Quant Toolkit for Signals & Risk
+
+- **Purpose**: Build/test models like NLP sentiment, VaR/CVaR risk, optimization.
+- **Features**: Currently Sentiment analysis, and Topic Modeling.
+- **Example**: Sentiment-Based Entry:
+
+```python
+from bbstrader.models import SentimenSentimentAnalyzer
+
+model = SentimenSentimentAnalyzer()  # Loads pre-trained NLP
+score = model.analyze_sentiment("Fed hikes rates – markets soar!")
+if score > 0.7:  # Bullish? Buy!
+    print("Go long!")
+```
+
+### **Other Modules:**
+
+`core`: Utilities (data structs, logging).
+`config`: Manages JSON configs in ~/.bbstrader/.
+`api`: Handler injections for bridges.
+
+## Getting Started
+
+### Prerequisites
+
+- **Python**: Python 3.12+ is required.
+- **MetaTrader 5 (MT5)**: Required for live execution (Windows).
+- **MT5 Broker**: [Admirals](https://one.justmarkets.link/a/tufvj0xugm/registration/trader), [JustMarkets](https://one.justmarkets.link/a/tufvj0xugm/registration/trader), [FTMO](https://trader.ftmo.com/?affiliates=JGmeuQqepAZLMcdOEQRp).
+
+## Installation
+
+`bbstrader` is designed for both Python and C++ developers. Follow the instructions that best suit your needs.
+
+### For the Python Quant
+
+Get started in minutes using `pip`. We strongly recommend using a virtual environment.
+
+```bash
+# Create and activate a virtual environment
+python -m venv venv
+source venv/bin/activate  # on Linux/macOS
+venv\Scripts\activate     # on Windows
+
+# Install bbstrader
+pip install bbstrader[MT5] # Windows
+pip install bbstrader  # Linux/macOS
+```
+
+### For the C++ Developer
+
+To develop your own C++ strategies, you can use `vcpkg` to install the `bbstrader` library and its dependencies.
+
+```bash
+# If you don't have vcpkg, clone and bootstrap it
+git clone https://github.com/microsoft/vcpkg
+./vcpkg/bootstrap-vcpkg.sh or ./vcpkg/bootstrap-vcpkg.bat
+
+# Install bbstrader
+./vcpkg/vcpkg install bbstrader
+```
+
+## CLI workflow
+
+`bbstrader` shines via CLI – launch everything from one command!
+
+| Action             | Command                                                                                                               |
+| :----------------- | :-------------------------------------------------------------------------------------------------------------------- |
+| **Run Backtest**   | `python -m bbstrader --run backtest --strategy SMAStrategy --account MY_ACCOUNT --config backtest.json`               |
+| **Live Execution** | `python -m bbstrader --run execution --strategy KalmanFilter --account MY_ACCOUNT --config execution.json --parallel` |
+| **Copy Trades**    | `python -m bbstrader --run copier --source 123456 --targets 789012 --risk_multiplier 2.0`                             |
+| **Get Help**       | `python -m bbstrader --help`                                                                                          |
+
+**Config Example** (`~/.bbstrader/execution/execution.json`):
+
+```json
+{
+  "SMAStrategy": {
+    "MY_MT5_ACCOUNT_1": {
+      "symbol_list": ["EURUSD", "GBPUSD"],
+      "trades_kwargs": { "magic": 12345, "comment": "SMA_Live" },
+      "short_window": 20,
+      "long_window": 50
+    }
+  }
+}
+```
+
+## 🌍 Community & Support
+
+- **[Read the Docs](https://bbstrader.readthedocs.io/en/latest/)**: Full API reference and tutorials.
+- **[GitHub Issues](https://github.com/bbalouki/bbstrader/issues)**: Report bugs or request features.
+- **[LinkedIn](https://www.linkedin.com/in/bertin-balouki-s-15b17a1a6)**: Connect with the creator.
+
+---
+
+### Professional Services
+
+If you need a custom trading strategy, a proprietary risk model, advanced data pipelines, or a dedicated copy trading server setup, professional services are available.
+
+**Contact the Developer:**  
+📧 [bertin@bbs-trading.com](mailto:bertin@bbs-trading.com)
+
+---
+
+### Support the Project
+
+If you find this project useful and would like to support its continued development, you can contribute here:
+
+☕ [Support the Developer](https://paypal.me/bertinbalouki?country.x=SN&locale.x=en_US)
+
+---
+
+_Disclaimer: Trading involves significant risk. `bbstrader` provides the tools, but you provide the strategy. Test thoroughly on demo accounts before deploying real capital._