Skip to content

Commit 07d2851

Browse files
committed
Update README files
Update requirements files
1 parent b635baa commit 07d2851

File tree

5 files changed

+137
-40
lines changed

5 files changed

+137
-40
lines changed

README.md

Lines changed: 33 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -84,14 +84,14 @@ This example project contains the following files and folders
8484

8585
The first step is to unzip or download the example project folder into a directory of your choice, then choose how to run the application based on your environment below.
8686

87-
### <a id="how_to_setup"></a>Set Up Environment
87+
### <a id="how_to_setup_console"></a>Set Up A Console Environment
8888

8989
It is an advisable to create a dedicate Python environment to run each Python project. You can create a new Conda environment names *MRN_RTO* with the following steps
9090

9191
1. Open Anaconda Prompt and go to the project's folder
9292
2. Run the following command in an Anaconda Prompt to create a Conda environment named *MRN_RTO* for the project.
9393
```
94-
(base) $>conda create --name MRN_RTO python=3.8
94+
(base) $>conda create --name MRN_RTO python=3.10
9595
```
9696
3. Once the environment is created, activate MRN_RTO environment with this command in Anaconda Prompt
9797
```
@@ -101,24 +101,39 @@ It is an advisable to create a dedicate Python environment to run each Python pr
101101
```
102102
(MRN_RTO) $>pip install -r requirements.txt
103103
```
104+
105+
### <a id="how_to_setup"></a>Set Up A Jupyter Notebook Environment
106+
107+
It is an advisable to create a dedicate Python environment to run each Python project. You can create a new Conda environment names *MRN_RTO* with the following steps
108+
109+
1. Open Anaconda Prompt and go to the project's folder
110+
2. Run the following command in an Anaconda Prompt to create a Conda environment named *MRN_Notebook* for the project.
111+
```
112+
(base) $>conda create --name MRN_Notebook python=3.10
113+
```
114+
3. Once the environment is created, activate MRN_Notebook environment with this command in Anaconda Prompt
115+
```
116+
(base) $>conda activate MRN_Notebook
117+
```
118+
4. Run the following command to install the dependencies in the *MRN_Notebook* environment
119+
```
120+
(MRN_Notebook) $>pip install -r requirements_notebook.txt
121+
```
122+
104123
### <a id="rtds_jupyter"></a>RTDS Jupyter Notebook example
105124

106125
Please be informed that your Real-Time Advanced Data Hub and Real-Time Advanced Distribution Server should have a Service that contains MRN data. The Python [Anaconda](https://www.anaconda.com/distribution/) or [MiniConda](https://docs.conda.io/en/latest/miniconda.html) distribution/package manager is highly recommended for running the JupyterLab example.
107126

108127
1. Open Anaconda Prompt and go to the project's folder
109128
2. Activate MRN_RTO environment with this command in Anaconda Prompt
110129
```
111-
(base) $>conda activate MRN_RTO
112-
```
113-
3. Run the following command to install the JupyterLab application and pandas in the *MRN_RTO* environment
114-
```
115-
(MRN_RTO) $>conda install -c conda-forge jupyterlab pandas
130+
(base) $>conda activate MRN_Notebook
116131
```
117-
4. In the current Anaconda Prompt, go to the project's notebook folder. Run the following command to start the JupyterLab application in the notebook folder.
132+
3. In the current Anaconda Prompt, go to the project's notebook folder. Run the following command to start the JupyterLab application in the notebook folder.
118133
```
119-
(MRN_RTO) $>jupyter lab
134+
(MRN_Notebook) $>jupyter lab
120135
```
121-
5. Open *mrn_notebook_app.ipynb* Notebook document, then follow through each notebook cell.
136+
4. Open *mrn_notebook_app_rtds.ipynb* Notebook document, then follow through each notebook cell.
122137

123138
### <a id="rtds_console"></a>RTDS Console example
124139

@@ -140,17 +155,13 @@ Please be informed that your Real-Time Advanced Data Hub and Real-Time Advanced
140155
Please be informed that your RTO access credentials should have a permission to request MRN data.
141156

142157
1. Open Anaconda Prompt and go to the project's folder
143-
2. Activate MRN_RTO environment with this command in Anaconda Prompt
144-
```
145-
(base) $>conda activate MRN_RTO
146-
```
147-
3. Run the following command to install the JupyterLab application in the *MRN_RTO* environment
158+
2. Activate MRN_Notebook environment with this command in Anaconda Prompt
148159
```
149-
(MRN_RTO) $>conda install -c conda-forge jupyterlab
160+
(base) $>conda activate MRN_Notebook
150161
```
151-
4. Go to the project's notebook folder. and create a file name ```.env``` with the following content.
162+
3. Go to the project's notebook folder. and create a file name ```.env``` with the following content.
152163
```
153-
# RTO Credentials
164+
# RTO Authentication Version 1 Credentials
154165
RTO_USERNAME=<Your RTO Machine-ID>
155166
RTO_PASSWORD=<Your RTO Password>
156167
RTO_CLIENTID=<Your RTO App Key>
@@ -160,13 +171,13 @@ Please be informed that your RTO access credentials should have a permission to
160171
RDP_AUTH_URL=/auth/oauth2/v1/token
161172
RDP_DISCOVERY_URL=/streaming/pricing/v1/
162173
```
163-
5. In the current Anaconda Prompt notebook folder. Run the following command to start the JupyterLab application in the notebook folder.
174+
4. In the current Anaconda Prompt notebook folder. Run the following command to start the JupyterLab application in the notebook folder.
164175
```
165-
(MRN_RTO) $>jupyter lab
176+
(MRN_Notebook) $>jupyter lab
166177
```
167-
6. Open *mrn_notebook_app_rto.ipynb* Notebook document, then follow through each notebook cell.
178+
5. Open *mrn_notebook_app_rto_v1.ipynb* Notebook document, then follow through each notebook cell.
168179

169-
### <a id="rto_console"></a>RTO console example
180+
### <a id="rto_console"></a>RTO Authentication Version 1 Console Example
170181

171182
Please check my colleague's [LSEG-API-Samples/Example.WebSocketAPI.Python.MRN.RTO](https://github.com/LSEG-API-Samples/Example.WebSocketAPI.Python.MRN.RTO) GitHub Repository.
172183

notebook/.env.example

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
# RTO Authentication Version 1 Credentials
12
RTO_USERNAME=Machine-ID
23
RTO_PASSWORD=RTO-Password
34
RTO_CLIENTID=App-Key

requirements.txt

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
1-
asttokens==2.0.5
2-
certifi==2021.10.8
3-
charset-normalizer==2.0.8
4-
cycler==0.10.0
5-
idna==3.3
6-
kiwisolver==1.3.1
7-
pyparsing==2.4.7
8-
python-dotenv==0.19.0
9-
requests==2.26.0
10-
urllib3==1.26.7
11-
websocket-client==1.2.1
12-
wincertstore==0.2
1+
certifi==2024.2.2
2+
charset-normalizer==3.3.2
3+
idna==3.7
4+
requests==2.31.0
5+
urllib3==2.2.1
6+
websocket-client==1.8.0

requirements_2.txt

Lines changed: 0 additions & 6 deletions
This file was deleted.

requirements_notebook.txt

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
anyio==4.3.0
2+
argon2-cffi==23.1.0
3+
argon2-cffi-bindings==21.2.0
4+
arrow==1.3.0
5+
asttokens==2.4.1
6+
async-lru==2.0.4
7+
attrs==23.2.0
8+
Babel==2.15.0
9+
beautifulsoup4==4.12.3
10+
bleach==6.1.0
11+
certifi==2024.2.2
12+
cffi==1.16.0
13+
charset-normalizer==3.3.2
14+
colorama==0.4.6
15+
comm==0.2.2
16+
debugpy==1.8.1
17+
decorator==5.1.1
18+
defusedxml==0.7.1
19+
exceptiongroup==1.2.1
20+
executing==2.0.1
21+
fastjsonschema==2.19.1
22+
fqdn==1.5.1
23+
h11==0.14.0
24+
httpcore==1.0.5
25+
httpx==0.27.0
26+
idna==3.7
27+
ipykernel==6.29.4
28+
ipython==8.24.0
29+
isoduration==20.11.0
30+
jedi==0.19.1
31+
Jinja2==3.1.4
32+
json5==0.9.25
33+
jsonpointer==2.4
34+
jsonschema==4.22.0
35+
jsonschema-specifications==2023.12.1
36+
jupyter-events==0.10.0
37+
jupyter-lsp==2.2.5
38+
jupyter_client==8.6.1
39+
jupyter_core==5.7.2
40+
jupyter_server==2.14.0
41+
jupyter_server_terminals==0.5.3
42+
jupyterlab==4.2.0
43+
jupyterlab_pygments==0.3.0
44+
jupyterlab_server==2.27.1
45+
MarkupSafe==2.1.5
46+
matplotlib-inline==0.1.7
47+
mistune==3.0.2
48+
nbclient==0.10.0
49+
nbconvert==7.16.4
50+
nbformat==5.10.4
51+
nest-asyncio==1.6.0
52+
notebook_shim==0.2.4
53+
numpy==1.26.4
54+
overrides==7.7.0
55+
packaging==24.0
56+
pandas==2.2.2
57+
pandocfilters==1.5.1
58+
parso==0.8.4
59+
platformdirs==4.2.1
60+
prometheus_client==0.20.0
61+
prompt-toolkit==3.0.43
62+
psutil==5.9.8
63+
pure-eval==0.2.2
64+
pycparser==2.22
65+
Pygments==2.18.0
66+
python-dateutil==2.9.0.post0
67+
python-dotenv==1.0.1
68+
python-json-logger==2.0.7
69+
pytz==2024.1
70+
pywin32==306
71+
pywinpty==2.0.13
72+
PyYAML==6.0.1
73+
pyzmq==26.0.3
74+
referencing==0.35.1
75+
requests==2.31.0
76+
rfc3339-validator==0.1.4
77+
rfc3986-validator==0.1.1
78+
rpds-py==0.18.1
79+
Send2Trash==1.8.3
80+
six==1.16.0
81+
sniffio==1.3.1
82+
soupsieve==2.5
83+
stack-data==0.6.3
84+
terminado==0.18.1
85+
tinycss2==1.3.0
86+
tomli==2.0.1
87+
tornado==6.4
88+
traitlets==5.14.3
89+
types-python-dateutil==2.9.0.20240316
90+
typing_extensions==4.11.0
91+
tzdata==2024.1
92+
uri-template==1.3.0
93+
urllib3==2.2.1
94+
wcwidth==0.2.13
95+
webcolors==1.13
96+
webencodings==0.5.1
97+
websocket-client==1.8.0

0 commit comments

Comments
 (0)