pre-commit

Author: Joaopeuko

mqpy/__init__.py

@@ -0,0 +1,7 @@
+"""  Python integration package.
+
+This package provides a bridge between Python and MetaTrader 5, allowing users to
+create Expert Advisors and implement trading strategies in Python.
+"""
+
+from .version import __version__

mqpy/indicator_connector.py

@@ -1,4 +1,4 @@
-"""MetaQuotes Language 5 Python integration module for technical indicators.
+"""  Python integration module for technical indicators.
 
 This module provides a bridge between Python and MT5 indicators through socket connections.
 """

scripts/gen_ref_pages.py

@@ -1,7 +1,6 @@
 #!/usr/bin/env python
 """Generate the API reference pages for the MQPy package."""
 
-import os
 import sys
 from pathlib import Path
 
@@ -18,7 +17,8 @@
 nav = mkdocs_gen_files.Nav()
 
 # Ensure the reference directory exists
-os.makedirs(project_dir / "docs" / "reference", exist_ok=True)
+reference_dir = project_dir / "docs" / "reference"
+reference_dir.mkdir(parents=True, exist_ok=True)
 
 # Create an index page with a better layout
 index_path = Path("reference", "index.md")
@@ -44,17 +44,13 @@
     import_path = ".".join(parts)
 
     # Create directory for the documentation
-    os.makedirs(full_doc_path.parent, exist_ok=True)
+    full_doc_path.parent.mkdir(parents=True, exist_ok=True)
 
-    # Write the page content - customized to skip module headers
+    # Write the page content
     with mkdocs_gen_files.open(full_doc_path, "w") as fd:
-        # Instead of directly using the main import path, create a custom approach
-        # that doesn't show the module header but still shows classes and functions
-        # fd.write("---\nhide:\n  - toc\n---\n\n")
         fd.write("<!-- Auto-generated API documentation -->\n\n")
 
-        # Write documentation for classes and functions instead of the module
-        # This approach avoids generating the module header while still including all content
+        # Write documentation for classes and functions
         fd.write(f"::: {import_path}\n")
 
     # Create title case version of the module name for navigation

setup.py

@@ -1,3 +1,9 @@
+"""Setup script for the mqpy package.
+
+This module contains the setup configuration for the mqpy package, which provides a Python interface
+for creating Expert Advisors in MetaTrader 5.
+"""
+
 import pathlib
 
 import setuptools
@@ -7,7 +13,10 @@
 setuptools.setup(
     name="mqpy",
     version="v0.6.9",
-    description="I developed this library to simplify the process of creating an Expert Advisor in MQL5. While developing in MQL5 can be complex, the same task is more streamlined in Python.",
+    description=(
+        "A library to simplify the process of creating an Expert Advisor in MQL5. "
+        "It makes Python development more streamlined than MQL5."
+    ),
     author="Joao Paulo Euko",
     license="MIT",
     keywords=["metatrader5", "algotrading", "stock market"],