Merge pull request #5 from spotware/dev

Dev

Author: amusleh-spotware-com

.gitignore

@@ -135,3 +135,5 @@ dmypy.json
 /samples/ConsoleSample/config-quote.json
 /samples/KleinWebAppSample/config-trade.json
 /samples/KleinWebAppSample/config-quote.json
+/samples/jupyter/config-trade.json
+/samples/jupyter/config-quote.json

README.md

@@ -27,11 +27,64 @@ This package uses Twisted and it works asynchronously.
 pip install ctrader-fix
 ```
 
+# Config
+
+Config file sample:
+
+```json
+{
+  "Host": "",
+  "Port": 0,
+  "SSL": false,
+  "Username": "",
+  "Password": "",
+  "BeginString": "FIX.4.4",
+  "SenderCompID": "",
+  "SenderSubID": "QUOTE",
+  "TargetCompID": "cServer",
+  "TargetSubID": "QUOTE",
+  "HeartBeat": "30"
+}
+```
+
 # Usage
 
 ```python
-
-
+from twisted.internet import reactor
+from inputimeout import inputimeout, TimeoutOccurred
+import json
+from ctrader_fix import *
+
+# Callback for receiving all messages
+def onMessageReceived(client, responseMessage):
+    print("Received: ", responseMessage.getMessage().replace("
", "|"))
+    messageType = responseMessage.getFieldValue(35)
+    if messageType == "A":
+        print("We are logged in")
+
+# Callback for client disconnection
+def disconnected(client, reason): 
+    print("Disconnected, reason: ", reason)
+
+# Callback for client connection
+def connected(client):
+    print("Connected")
+    logonRequest = LogonRequest(config)
+    send(logonRequest)
+
+# you can use two separate config files for QUOTE and TRADE
+with open("config-trade.json") as configFile:
+    config = json.load(configFile)
+
+client = Client(config["Host"], config["Port"], ssl = config["SSL"])
+
+# Setting client callbacks
+client.setConnectedCallback(connected)
+client.setDisconnectedCallback(disconnected)
+client.setMessageReceivedCallback(onMessageReceived)
+# Starting the client service
+client.startService()
+reactor.run()
 ```
 
 Please check documentation or samples for a complete example.

samples/jupyter/README.md

@@ -1,9 +1,27 @@
 # Jupyter Sample
 
-This is sample that will show you how to use the OpenApiPy Python package on a Jupyter notebook.
+This is sample that will show you how to use the cTraderFix Python package on a Jupyter notebook.
 
-In the notebook we get the daily bars data from cTrader Open API, then we use it to train a sklearn model.
+In the notebook we logon, retrive account securities/symbols, and then we execute a market order.
 
-To use the sample you have to create a copy of "credentials.json" file and rename it to "credentials-dev.json".
+Before running the sample you have to create a config file and fill it with your trading account FIX API credentials.
 
-Then fill the file with your Open API application credentials, access token, and a trading account ID.
+Then replace the config file name on sample main file to your config file name.
+
+Config file sample:
+
+```json
+{
+  "Host": "",
+  "Port": 0,
+  "SSL": false,
+  "Username": "",
+  "Password": "",
+  "BeginString": "FIX.4.4",
+  "SenderCompID": "",
+  "SenderSubID": "QUOTE",
+  "TargetCompID": "cServer",
+  "TargetSubID": "QUOTE",
+  "HeartBeat": "30"
+}
+```

samples/jupyter/config.json

@@ -0,0 +1,13 @@
+{
+  "Host": "",
+  "Port": 0,
+  "SSL": false,
+  "Username": "",
+  "Password": "",
+  "BeginString": "FIX.4.4",
+  "SenderCompID": "",
+  "SenderSubID": "QUOTE",
+  "TargetCompID": "cServer",
+  "TargetSubID": "QUOTE",
+  "HeartBeat": "30"
+}