Pre-commit trade.py

Author: Joaopeuko

.codespell-ignore

@@ -1,8 +1,8 @@
 name: Deploy | Semantic Release
 
 on:
-  push:
-    branches: ['main']
+  workflow_dispatch:
+
 jobs:
   release:
     runs-on: windows-latest

.github/workflows/deploy-semantic-release.yaml

@@ -1,3 +1,7 @@
+"""Example trading strategy using the MQL5-Python integration.
+This example demonstrates a Moving Average Crossover strategy.
+"""
+
 from mqpy.src.rates import Rates
 from mqpy.src.tick import Tick
 from mqpy.src.trade import Trade

example.py

@@ -1,3 +1,7 @@
+"""Example Expert Advisor demonstrating socket connections with MetaTrader 5.
+This example uses stochastic oscillator and moving average indicators to generate trading signals.
+"""
+
 import MetaTrader5 as Mt5
 from include.indicator_connector import Indicator
 from include.rates import Rates

examples_of_expert_advisor/example_sockets_connection.py

@@ -1,3 +1,7 @@
+"""EURUSD FiMathe Expert Advisor for MetaTrader 5.
+This Expert Advisor uses Fibonacci retracement levels to determine entry and exit points.
+"""
+
 import MetaTrader5 as Mt5
 import numpy as np
 from include.rates import Rates

examples_of_expert_advisor/fimathe/eurusd_fimathe.py

@@ -1,3 +1,7 @@
+"""WIN FiMathe Expert Advisor for MetaTrader 5.
+This Expert Advisor is designed for WING21 futures, using Fibonacci retracement levels to determine entry and exit points.
+"""
+
 import MetaTrader5 as Mt5
 import numpy as np
 from include.rates import Rates

examples_of_expert_advisor/fimathe/win_fimathe.py

@@ -1,3 +1,5 @@
+"""Main entry point for the MQL5-Python integration package."""
+
 from .template import main
 
 if __name__ == "__main__":

mqpy/__main__.py

@@ -1,4 +1,4 @@
-from typing import Optional
+from typing import Any, Dict, Optional
 
 import MetaTrader5 as Mt5
 
@@ -21,11 +21,11 @@ def __init__(self, symbol: str) -> None:
         else:
             print(f"Error adding {self.symbol} to the market book. Error: {Mt5.last_error()}")
 
-    def get(self) -> Optional[dict]:
+    def get(self) -> Optional[Dict[str, Any]]:
         """Get the market book for the financial instrument.
 
         Returns:
-            Optional[dict]: A dictionary representing the market book, or None if unsuccessful.
+            Optional[Dict[str, Any]]: A dictionary representing the market book, or None if unsuccessful.
         """
         return Mt5.market_book_get(self.symbol)