Moved DLLs to /libs

* fixed default path in pythonnet imports
* moved DLLs to own ./libs directory
* added PR template (WIP)
* Updated README

Author: eabase

.github/pull_request_template.md

@@ -0,0 +1,40 @@
+<!--- Provide a general summary of your changes in the Title above -->
+
+#### Description
+<!--- Describe your changes in detail -->
+
+#### Related Issue
+<!--- This project only accepts pull requests related to open issues -->
+<!--- If suggesting a new feature or change, please discuss it in an issue first -->
+<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
+<!--- Please link to the issue here: -->
+
+#### Motivation and Context
+<!--- Why is this change required? What problem does it solve? -->
+
+#### Requires Documentation Change
+<!--- Please indicate if these changes will require updates to documentation, and if so, specify what changes are required -->
+
+#### How Has This Been Tested?
+<!--- Please describe in detail how you tested your changes. -->
+<!--- Include details of your testing environment, and the tests you ran to -->
+<!--- see how your change affects other areas of the code, etc. -->
+
+#### Types of changes
+<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] Refactor (non-breaking change which improves implementation)
+- [ ] Performance (non-breaking change which improves performance. Please add associated performance test and results)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to change)
+- [ ] Non-functional change (xml comments/documentation/etc)
+
+#### Checklist:
+<!--- The following is a checklist of items that MUST be completed before a PR is accepted -->
+<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
+- [ ] My code follows the code style of this project.
+- [ ] I have read the **CONTRIBUTING** [document](https://github.com/eabase/mt4pycon/blob/master/CONTRIBUTING.md).
+<!--- - [ ] I have added tests to cover my changes.--> 
+<!--- If not applicable, please explain why -->
+<!--- - [ ] All new and existing tests passed. -->
+- [ ] My branch follows the naming convention `bug-<issue#>-<description>` or `feature-<issue#>-<description>`

.gitignore

@@ -16,5 +16,6 @@
 /junk/
 
 # MtAtpi DLL's
-*.dll
+#*.dll
+#/**/*.dll
 

README.md

@@ -13,14 +13,14 @@
 
 
 The **`mt4pycon`** repo is a collection of Python3 code used to interface with MT4 and MT5 
-terminals via 3rd party API's. As of today there is only one script available, but will 
+terminals via 3rd party API's. As of today there is only 2 scripts available, but will 
 soon contain several other examples for simple indicators, data scrapers/analyzers to 
 AI/ML automated trading bots.
 
 
 ---
 
-**`con2mtapi`**
+**`con2mtapi.py`**
 
 This is a simple *Python3* CLI client that is using the MT4 bridge API 
 ([mtapi](https://github.com/vdemydiuk/mtapi/)) to connect to a MT4 Terminal which 
@@ -30,6 +30,12 @@ for a specified symbol and timeframe. This particular script is using the MQL bu
 `CopyRates` and `iBars()` functions for receiving the candle data.
 
 
+**`liveTicks.py`**
+
+A very rudimentary data feed that is continusly *polling* the MQL `SymbolInfoTick(sym)` 
+funtion, to display *Time, Bid, Ask* and *Spread* (in points), for a given symbol.
+This should probably be rewritten using a threaded listener...
+
 Example Output:
 
 <sub>Using symbolic TF and normal tabulated output.</sub>  
@@ -38,6 +44,9 @@ Example Output:
 <sub>Using numerical TF and CSV output.</sub>  
 ![Full](./docs/image2.png)
 
+<sub>Live Tick stream with Spread...</sub>  
+![Full](./docs/image3.png)
+
 ---
 
 **Q:** *What is **`mtapi`** and what does it do?*
@@ -107,6 +116,7 @@ As always, any small crypto donation is an inspitring incentive to make things h
 Python packages: 
 
 * [pythonnet](https://github.com/pythonnet/pythonnet) - `Python.NET` for the .NET *Common Language Runtime* (CLR)
+* [pyreadline](https://github.com/pyreadline/pyreadline) - [Not Required] *"You don't wanna develop without it!"*
 
 and what you already have: 
 * [MT4](https://github.com/rosasurfer/mt4-mql) - Latest (unbranded) MT4 and MetaEditor4 downloads
@@ -239,16 +249,16 @@ If you want to compile your own MtApi libraries, please check the original
 *mtapi* github repo for detailed compilation instructions.
 
 In summary, for modifying the EA, you would need to:  
-(a) Copy the `MtApi.mq4` file into the `../MQL4/Experts/` folder  
-(b) copy the following MQL Library files into the `../MQL4/Include/` folder:  
+**(a)** Copy the `MtApi.mq4` file into the `../MQL4/Experts/` folder.  
+**(b)** Copy the following MQL Library files into the `../MQL4/Include/` folder:  
 
 ```bash
 hash.mqh
 json.mqh
 mql4-auth.mqh
 ```
 
-(c) Recompile `MtAPi.mq4` in *MetaEditor4*.
+**(c)** Recompile `MtApi.mq4` in *MetaEditor4*.
 
 
 ---
@@ -351,15 +361,17 @@ C:\Users\<username>\AppData\Roaming\MetaQuotes\Terminal\<unique-hash>\MQL4\Exper
 
 #### Recommeded Similar Tools:
 
-`TBA`
+* [dwx-zeromq-connector](https://github.com/darwinex/dwx-zeromq-connector) (*ZeroMQ-enabled MetaTrader Bridge EA*)
+* [mql4-lib](https://github.com/dingmaotu/mql4-lib) (*MQL4/5 Foundation Library*)
+* [mql-zmq](https://github.com/dingmaotu/mql-zmq) (*ZMQ binding for the MQL*)
 
 
 #### Known Bugs and Warnings
 
-* When running the script for the *first* time on a certain symbol and timeframe, the 
+:negative_squared_cross_mark: When running the script for the *first* time on a certain symbol and timeframe, the 
 candle data will not be available in the MT4 terminal buffer, so the script will fail. 
-Just run it again and MT4 will most likely have already downloaded the new data. I have 
-not been able to resolve this issue. 
+Just run it again and MT4 will most likely have already downloaded the new data. A bug report 
+has been filed in this [issue](#4). 
 
 
 #### ToDo / Help Needed
@@ -372,24 +384,14 @@ Feel free to post issues and PR's related to this tool.
 Feel free to fork, break, fix and contribute. Enjoy!
 
 
-#### Donation
+#### Donations
 
 Almost everything I do is Free and Open Source Software (FOSS). 
 This means that I do not receive any income on any of my projects. 
 So if you find any of my projects or code, cool & useful, please 
 consider making a small donation to any of my crypto accounts.
 
-<details><summary>Adresses</summary>
-
-| Symbol | Name | Address |
-|:--------:|:--------:|:--------|
-| BTC | Bitcoin  | `bc1qkcyxnerc2sa8xn8d30wkgfqy64jhcxxzf0xv05` |
-| ZEC | Zcash    | `t1aDszWfkHcSR5yjYrpjYLxj44Lfw7g9GDn` |
-| XMR | Monero   | `43ACVrQMQ23bh99S7ohJ4cbDA7mVXwUcYRNjyVkr4t3bgqikfpvQu9i4aBeu7vmzCKJek3pkidEFMYEZ6fJpb6Y6HgPAC5m` |
-| ETH | Ethereum | `0x53266f143193e08B91bF943a694f8F9D9435163B` |
-| LTC | Litecoin | `LW7Eu5omvBPRA1sXrKDtemVBrMYzFdwRAF` |
-
-</details>
+See my [profile](https://github.com/eabase) page for Crypto Adresses.
 
 
 #### Additional Badges

con2mtapi.py

@@ -106,7 +106,9 @@
 # For MT4 installs
 #--------------------------------------
 # C:\Program Files (x86)\MtApi
-sys.path.append(r"C:\Program Files\MtApi")
+#sys.path.append(r"C:\Program Files\MtApi")
+#sys.path.append(r"C:\Program Files (x86)\MtApi")
+sys.path.append(r".\libs")
 asm = clr.AddReference('MtApi')
 import MtApi as mt
 

libs/MtApi.dll

@@ -0,0 +1,3 @@
+This folder contain the latest built DLL's from the mtapi releases.
+For usage, please consult that repo.
+