diff --git a/README.md b/README.md index f1cbeae..57b9688 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +# Mql5-Python-Integration (MQPy) +

MQPy Logo

@@ -9,84 +11,57 @@ PyPI - License

-

Mql5-Python-Integration (MQPy)

- -

Current Version: v0.6.9

- -Welcome to the Mql5-Python-Integration project! This project facilitates the integration between MetaTrader 5 (Mql5) and Python, allowing for efficient algorithmic trading strategies. - -## ⚠️ TRADING RISK WARNING +A Python library designed to simplify the process of creating Expert Advisors for MetaTrader 5. While developing directly in MQL5 can be complex, MQPy provides a more streamlined experience using Python. -**IMPORTANT: Trading involves substantial risk of loss and is not suitable for all investors.** +## ⚠️ Important Notice -- Always use a **demo account** with fake money when testing strategies -- MQPy is provided for **educational purposes only** -- Past performance is not indicative of future results +Trading involves risk. Always: +- Use demo accounts for testing - Never trade with money you cannot afford to lose -- The developers are not responsible for any financial losses incurred from using this software - -## Table of Contents - -- [⚠️ TRADING RISK WARNING](#️-trading-risk-warning) -- [Table of Contents](#table-of-contents) -- [Project Update: Changes in Progress](#project-update-changes-in-progress) -- [Installation](#installation) -- [Usage](#usage) - - [Generate the File](#generate-the-file) -- [Missing Features/Good Practice](#missing-featuresgood-practice) - - [Delicate Metatrader5 Environment](#delicate-metatrader5-environment) - - [Alternative Libraries](#alternative-libraries) - -## Project Update: Changes in Progress - -🚧 **Work in Progress: v0.6.9** -This project is currently undergoing significant changes and improvements. The latest version is v0.6.0, and various enhancements are being made to provide a more robust and user-friendly experience. - -📌 **Previous Version: v0.5.0** -To access the code for the previous version, you can check it out at [v0.5.0](https://github.com/Joaopeuko/Mql5-Python-Integration/releases/tag/v0.5.0). +- Understand that past performance doesn't guarantee future results ## Installation -**Note: In order to use this package, you need to have MetaTrader 5 installed on a Windows system with Python 3.8 or later.** - -To install the package, you can use the following command: - ```bash pip install mqpy ``` -Make sure to fulfill the prerequisites mentioned above before attempting to use the Mql5-Python-Integration (MQPy) package. - -## Usage +## Requirements -Basic Usage +- Windows OS +- Python 3.8 or later +- MetaTrader 5 installed -Once installed, you can use the mqpy command to generate the boilerplate code. +## Quick Start -### Generate the File - -To create a template file for a trading strategy, use the following command: +Generate a trading strategy template: ```bash -mqpy --symbol --file_name +mqpy --symbol EURUSD --file_name my_strategy ``` -Please change `` and `` to the desired values. For example: - -```bash -mqpy --symbol EURUSD --file_name demo -``` +## Features -## Missing Features/Good Practice +- Simple integration with MetaTrader 5 +- Easy-to-use command line interface +- Basic template generation for trading strategies +- Support for various trading strategies: + - Moving Average Crossover + - RSI-based trading + - Bollinger Bands strategies + - Fibonacci Retracement patterns + - Multi-timeframe analysis + - Custom indicator integration -This library has been in existence for several years and was designed to be simple and straightforward. While there are plans to enhance it with features such as logging and other components to improve its overall quality, there are considerations specific to the nature of the Metatrader5 library. +## Documentation -### Delicate Metatrader5 Environment +For detailed documentation, examples, and strategy explanations, visit: +[https://joaopeuko.com/Mql5-Python-Integration/](https://joaopeuko.com/Mql5-Python-Integration/) -Metatrader5 operates within a highly restrictive environment, and certain practices that may be considered best practices in other contexts might cause trouble for newcomers in software development, which is the main focus of this library. For the sake of simplicity and ease of use, the library currently retains some practices that may not align with conventional best practices. +## Support -### Alternative Libraries +MQPy is a free and open-source project. If you'd like to support its development, consider becoming a sponsor. -For users seeking a more advanced library with a similar concept, consider exploring the following alternative: +## License -[metatrader5EasyT](https://github.com/Joaopeuko/metatrader5EasyT): A more advanced library that aligns with best practices while providing a similar user-friendly approach. It is also available on PyPI. +This project is licensed under the MIT License - see the LICENSE file for details.