Skip to content

Commit a20a3a3

Browse files
committed
Updated to use Python venv as a suggestion environment instead of Conda
1 parent ee5ad04 commit a20a3a3

File tree

1 file changed

+26
-14
lines changed

1 file changed

+26
-14
lines changed

README.md

Lines changed: 26 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -43,25 +43,30 @@ All source code and scripts are provided under the Apache 2.0 license. They are
4343
The following softwares are required to use this script
4444

4545
- RKD API credentials. Please reach out to your LSEG representative to acquire RKD access credentials.
46-
- Python [Anaconda](https://www.anaconda.com/distribution/) or [MiniConda](https://docs.conda.io/en/latest/miniconda.html) distribution/package manager.
46+
- [Python](https://www.python.org/).
4747
- The [JupyterLab](https://jupyter.org/) runtime (for the Notebook example application)
4848

4949
All scripts support Python 3 only and not compatible with Python 2.
5050

51+
5152
*Note:*
5253
- You can install 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.
53-
54+
- The Python [Anaconda](https://www.anaconda.com/distribution/) or [MiniConda](https://docs.conda.io/en/latest/miniconda.html) distribution/package manager are also supported.
5455

5556
### <a id="python_example_run"></a>How to run the Python Console examples
5657

57-
1. Open Anaconda Prompt and go to the project's Python folder
58-
2. Run the following command in the Anaconda Prompt application to create a Conda environment named *RKD_Python* for the project.
58+
1. Open Command Prompt and go to the project's Python folder
59+
2. Run the following command in the Command Prompt application to create a Python virtual environment named *RKD_Python* for the project.
5960
```bash
60-
(base) $>conda create --name RKD_Python python=3.9
61+
$>python -m venv RKD_Python
6162
```
62-
3. Once the environment is created, activate a Conda environment named ```RKD_Python``` with this command in Anaconda Prompt.
63+
3. Once the environment is created, activate an environment named ```RKD_Python``` with this command in Command Prompt.
6364
```bash
64-
(base) $>conda activate RKD_Python
65+
#Windows
66+
$>RKD_Python\Scripts\activate
67+
68+
#Linux
69+
$>source RKD_Python/bin/activate
6570
```
6671
4. Run the following command to the dependencies in the *RKD_Python* environment with a **requirements.txt** file.
6772
```bash
@@ -79,18 +84,22 @@ All scripts support Python 3 only and not compatible with Python 2.
7984
(RKD_Python) $>python <application>.py
8085
```
8186
82-
**Note**: The Python examples also compatible with the Python [venv](https://docs.python.org/3/library/venv.html).
87+
**Note**: The Python examples also compatible with the Python [Conda environment](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html).
8388
8489
### <a id="python_example_run"></a>How to run the Python Notebook examples
8590
86-
1. Open Anaconda Prompt and go to the project's Python folder
87-
2. Run the following command in the Anaconda Prompt application to create a Conda environment named *RKD_Python_Notebook* for the project.
91+
1. Open Command Prompt and go to the project's Python folder
92+
2. Run the following command in the Command Prompt application to create a Python virtual environment named *RKD_Python_Notebook* for the project.
8893
```bash
89-
(base) $>conda create --name RKD_Python_Notebook python=3.9
94+
$>python -m venv RKD_Python_Notebook
9095
```
91-
3. Once the environment is created, activate a Conda environment named ```RKD_Python_Notebook``` with this command in Anaconda Prompt.
96+
3. Once the environment is created, activate an environment named ```RKD_Python_Notebook``` with this command in Command Prompt.
9297
```bash
93-
(base) $>conda activate RKD_Python_Notebook
98+
#Windows
99+
$>RKD_Python_Notebook\Scripts\activate
100+
101+
#Linux
102+
$>source RKD_Python_Notebook/bin/activate
94103
```
95104
4. Run the following command to the dependencies in the *RKD_Python_Notebook* environment with a **requirements-notebook.txt** file.
96105
```bash
@@ -108,7 +117,7 @@ All scripts support Python 3 only and not compatible with Python 2.
108117
(RKD_Python_Notebook) $>notebook>jupyter lab
109118
```
110119
111-
**Note**: The Python Jupyter examples also compatible with the Python [venv](https://docs.python.org/3/library/venv.html).
120+
**Note**: The Python examples also compatible with the Python [Conda environment](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html).
112121
113122
Please follow the [JupyterLab installation guide](https://jupyter.org/install) page.
114123
@@ -182,3 +191,6 @@ For any questions related to this tutorial or RKD API, please use the Developer
182191
- Update libraries versions
183192
- version 1.6.5: January 2026
184193
- Rebranding LSEG
194+
- Updated all links to be up-to-date
195+
- Updated libraries
196+
- Updated to use Python venv as a suggestion environment instead of Conda.

0 commit comments

Comments
 (0)