|
6 | 6 |
|
7 | 7 | ## Overview |
8 | 8 |
|
9 | | -This example shows how to writing the [Elektron WebSocket API](https://developers.refinitiv.com/elektron/websocket-api) application to subscribe Machine Readable News (MRN) from Thomson Reuters Enterprise Platform (TREP). The example just connects to TREP via a WebSocket connection, then subscribes and display MRN News data in a console. The project are implemented with Python language, but the main concept for consuming and assembling MRN News messages are the same for all technologies. |
| 9 | +This example shows how to writing the [Elektron WebSocket API](https://developers.refinitiv.com/elektron/websocket-api) application to subscribe Machine Readable News (MRN) from Thomson Reuters Enterprise Platform (TREP). The example just connects to TREP via a WebSocket connection, then subscribes and display MRN News data in a console and . The project are implemented with Python language for both console and Jupyter Notebook applications, but the main concept for consuming and assembling MRN News messages are the same for all technologies. |
10 | 10 |
|
11 | 11 | *Note:* The news message is in UTF-8 JSON string format. Some news messages that contains special unicode character may not be able to show in Windows OS console (cmd, git bash, powershell, etc) due to the OS limitation. Those messages will be print as ```UnicodeEncodeError exception. Cannot decode unicode character``` message in a console instead. |
12 | 12 |
|
@@ -41,19 +41,22 @@ This example requires the following dependencies softwares and libraries. |
41 | 41 | 2. [Python](https://www.python.org/) compiler and runtime |
42 | 42 | 3. Python's [requests 2.x](https://pypi.org/project/requests/) library. |
43 | 43 | 4. Python's [websocket-client](https://pypi.org/project/websocket-client/) library (*version 0.49 or greater*). |
| 44 | +5. [Classic Jupyter Notebook](https://jupyter.org/) runtime (for the Notebook example application) |
44 | 45 |
|
45 | 46 | *Note:* |
46 | 47 | - The Python example has been qualified with Python versions 3.6.5. |
47 | 48 | - Please refer to the [pip installation guide page](https://pip.pypa.io/en/stable/installing/) if your environment does not have the [pip tool](https://pypi.org/project/pip/) installed. |
48 | 49 | - If your environment already have a websocket-client library installed, you can use ```pip list``` command to verify a library version, then use ```pip install --upgrade websocket-client``` command to upgrade websocket-client library. |
49 | 50 | - It is not advisable to change the ADH/ADS configuration, if you are not familiar with the configuration procedures. Please consult your Market Data administrator for any questions regarding TREP-MRN service configuration. |
| 51 | +- You can install a classic Jupyter Notebook on your local machine and then test the example on the machine. The alternate choice is a free Jupyter Notebook on cloud environment such as [Azure Notebook](https://notebooks.azure.com/) provided by Microsoft. You can find more details from [this tutorial](https://docs.microsoft.com/en-us/azure/notebooks/tutorial-create-run-jupyter-notebook). If you are not familiar with Jupyter Notebook, the following [tutorial](https://www.datacamp.com/community/tutorials/tutorial-jupyter-notebook) created by DataCamp may help. |
50 | 52 |
|
51 | 53 | ## Application Files |
52 | 54 | This example project contains the following files and folders |
53 | 55 | 1. *mrn_console_app.py*: The example application file |
54 | | -2. *requirements.txt*: The application dependencies configurationf file |
55 | | -3. LICENSE.md: Project's license file |
56 | | -4. README.md: Project's README file |
| 56 | +2. *notebook_python/mrn_notebook_app.ipynb*: The example Jupyter Notebook application file |
| 57 | +3. *requirements.txt*: The application dependencies configurationf file |
| 58 | +4. LICENSE.md: Project's license file |
| 59 | +5. README.md: Project's README file |
57 | 60 |
|
58 | 61 | ## How to run this console example |
59 | 62 |
|
|
0 commit comments