refactor: Re-arrange the project to make improvements

.github/ISSUE_TEMPLATE/build.yaml

@@ -10,7 +10,7 @@ body:
       label: "Where?"
       description: "Provide path from the root of the repository."
       placeholder: "mqpy/"
- 
+
   - type: textarea
     id: requested_change
     attributes:

.github/ISSUE_TEMPLATE/feat.yaml

@@ -16,4 +16,4 @@ body:
     attributes:
       label: Task Description
       description: Provide a clear and concise description of what needs to be done.
-      placeholder: Describe the problem or proposed solution.
+      placeholder: Describe the problem or proposed solution.

.github/ISSUE_TEMPLATE/perf.yaml

@@ -17,4 +17,3 @@ body:
       label: Area for Performance Improvement
       description: Specify the part of the codebase or system that requires optimization. Explain why it needs improvement and describe the current performance issue as the proposed solution.
       placeholder: e.g., "The sorting algorithm in module X is slow when handling large datasets."
-

.github/workflows/deploy-mkdocs.yml

@@ -0,0 +1,44 @@
+name: Deploy | Deploy MkDocs
+
+on:
+  workflow_dispatch:
+  push:
+    branches: ['main']
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  deploy:
+    runs-on: windows-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install uv and set the python version
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install the project
+        run: uv sync --locked --group docs
+
+      - name: Build MkDocs
+        run: mkdocs build --site-dir ./deploy
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: './deploy'
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

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

@@ -0,0 +1,24 @@
+name: Deploy | Semantic Release
+
+on:
+  workflow_dispatch:
+
+jobs:
+  release:
+    runs-on: windows-latest
+    concurrency: release
+    permissions:
+      contents: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Python Release
+        uses: python-semantic-release/python-semantic-release@v9.20.0
+        with:
+            github_token: ${{ secrets.GITHUB_TOKEN }}
+            push: "true"
+            changelog: "true"

.github/workflows/deploy.yaml

@@ -2,8 +2,7 @@ name: Publish distributions
 
 on:
   push:
-    branches:
-      - '*'
+    branches: ['main']
     tags:
       - v*
 

.github/workflows/test-metatrader5-integration.yml

@@ -0,0 +1,76 @@
+name: Test | Integration Test
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: windows-latest
+    timeout-minutes: 15
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.11'
+
+    - name: Download MetaTrader5 Installer
+      shell: pwsh
+      run: |
+        $url = "https://download.mql5.com/cdn/web/metaquotes.software.corp/mt5/mt5setup.exe"
+        $output = "$env:GITHUB_WORKSPACE\mt5setup.exe"
+        Invoke-WebRequest -Uri $url -OutFile $output
+        Write-Host "Download completed. File size: $((Get-Item $output).Length) bytes"
+
+    - name: Install MetaTrader5
+      run: |
+        $process = Start-Process -FilePath ".\mt5setup.exe" -ArgumentList "/auto", "/portable" -PassThru
+        $process.WaitForExit(300000)
+        if (-not $process.HasExited) {
+          Write-Host "MT5 installer stuck, killing..."
+          Stop-Process -Id $process.Id -Force
+          exit 1
+        }
+      shell: pwsh
+
+    - name: Launch MT5
+      shell: pwsh
+      run: |
+        $mt5Path = Resolve-Path "C:\Program Files\MetaTrader 5\terminal64.exe"
+
+        # Launch with diagnostics
+        Start-Process $mt5Path -ArgumentList @(
+            "/portable",
+            "/headless",
+            "/config:config",
+            "/noreport"
+        ) -NoNewWindow
+
+        # Verify process start
+        $attempts = 0
+        while ($attempts -lt 10) {
+            if (Get-Process terminal64 -ErrorAction SilentlyContinue) {
+                Write-Host "MT5 process detected"
+                break
+            }
+            $attempts++
+            Start-Sleep 5
+        }
+
+        if (-not (Get-Process terminal64 -ErrorAction SilentlyContinue)) {
+            Get-Content ".\MetaTrader 5\logs\*.log" | Write-Host
+            throw "MT5 failed to start"
+        }
+
+    - name: Install MetaTrader5 Python package
+      run: pip install MetaTrader5
+
+    - name: Run MT5 Test
+      env:
+        MT5_LOGIN: ${{ secrets.MT5_LOGIN }}
+        MT5_PASSWORD: ${{ secrets.MT5_PASSWORD }}
+        MT5_SERVER: "MetaQuotes-Demo"
+        MT5_PATH: "C:\\Program Files\\MetaTrader 5\\terminal64.exe"
+      run: |
+        python tests/integration/test_mt5_connection.py

.github/workflows/test-pre-commit.yaml

@@ -0,0 +1,20 @@
+name: Test | Pre-commit
+
+on:
+  pull_request:
+  push:
+    branches: ['*']
+
+jobs:
+  pre-commit:
+    permissions: write-all
+    runs-on: windows-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Run Pre-commit
+        uses: pre-commit/action@v3.0.1
+        with:
+          extra_args: --all-files

.gitignore

@@ -1,2 +1,2 @@
 .env
-*.pyc
+*.pyc

.pre-commit-config.yaml

@@ -1,23 +1,72 @@
+default_language_version:
+  python: python3
 repos:
-- repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.5.0
-  hooks:
-    - id: trailing-whitespace
-    - id: end-of-file-fixer
-    - id: check-yaml
-    - id: check-added-large-files
-      language_version: python3
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-ast
+      - id: check-builtin-literals
+      - id: check-byte-order-marker
+      - id: check-case-conflict
+      - id: check-docstring-first
+      - id: check-executables-have-shebangs
+      - id: check-json
+      - id: check-merge-conflict
+      - id: check-shebang-scripts-are-executable
+      - id: check-symlinks
+      - id: check-yaml
+      - id: debug-statements
+      - id: destroyed-symlinks
+      - id: end-of-file-fixer
+      - id: file-contents-sorter
+      - id: trailing-whitespace
 
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.8.6
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format
 
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.3.0
+    hooks:
+      - id: codespell
+        language: python
+        types: [text]
+        entry: codespell --ignore-words=.codespell-ignore --check-filenames
+        exclude: uv.lock
 
-- repo: https://github.com/psf/black
-  rev: 23.11.0
-  hooks:
-  - id: black
-    args: [--safe, --line-length=120]
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.14.1
+    hooks:
+      - id: mypy
+        name: mypy
+        pass_filenames: false
+        args:
+          [
+            --strict-equality,
+            --disallow-untyped-calls,
+            --disallow-untyped-defs,
+            --disallow-incomplete-defs,
+            --disallow-any-generics,
+            --check-untyped-defs,
+            --disallow-untyped-decorators,
+            --warn-redundant-casts,
+            --warn-unused-ignores,
+            --no-warn-no-return,
+            --warn-unreachable,
+          ]
+        additional_dependencies: ["types-requests", "types-PyYAML"]
 
-- repo: https://github.com/pycqa/isort
-  rev: 5.12.0
-  hooks:
-    - id: isort
-      args: [--profile=black]
+  - repo: local
+    hooks:
+      - id: pylint
+        name: pylint
+        entry: pylint
+        language: python
+        additional_dependencies: ["pylint"]
+        types: [python]
+        args: ["--disable=all", "--enable=missing-docstring,unused-argument"]
+        exclude: 'test_\.py$'

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Joao Euko
+Copyright (c) 2021-2025 Joao Euko
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,3 +1,8 @@
+<div style="display: flex; justify-content: center;">
+    <img src="docs/assets/logo.svg" alt="MQPy Logo" style="width: 200px; height: 200px;">
+</div>
+
+
 ![PyPI - Downloads](https://img.shields.io/pypi/dm/mqpy)
 ![PyPI](https://img.shields.io/pypi/v/mqpy)
 ![PyPI - Wheel](https://img.shields.io/pypi/wheel/mqpy)