Merge pull request #8 from LSEG-API-Samples/use_venv

Use venv

Author: wasin-waeosri

.dockerignore

@@ -8,4 +8,5 @@ sample_jsons/
 tests/__pycache__/
 README.md
 .git/
-.gitignore
+.gitignore
+testenv/

.gitignore

@@ -4,4 +4,6 @@ sample_jsons/
 tests/__pycache__/
 rdp_controller/__pycache__/
 __pycache__/
-tree.txt
+tree.txt
+
+testenv

Dockerfile

@@ -1,5 +1,5 @@
-ARG PYTHON_VERSION=3.9.13
-ARG VARIANT=slim-buster
+ARG PYTHON_VERSION=3.11
+ARG VARIANT=slim-bookworm
 
 #Build stage, using slim based-image because alpine cannot use Pandas and Matplotlib
 FROM python:${PYTHON_VERSION}-${VARIANT} AS builder
@@ -8,13 +8,15 @@ FROM python:${PYTHON_VERSION}-${VARIANT} AS builder
 COPY requirements.txt .
 
 # install dependencies to the local user directory (eg. /root/.local)
-RUN pip install --user -r requirements.txt
+#RUN pip install --user -r requirements.txt
+RUN pip install --trusted-host pypi.python.org --trusted-host files.pythonhosted.org --trusted-host pypi.org --no-cache-dir --user -r requirements.txt
+
 
 # Run stage, using slim based-image because alpine cannot use Pandas and Matplotlib
 FROM python:${PYTHON_VERSION}-${VARIANT}  
 WORKDIR /app
 
-LABEL maintainer="Developer Advocate"
+LABEL maintainer="Developer Relations"
 
 # Update PATH environment variable + set Python buffer to make Docker print every message instantly.
 ENV PATH=/root/.local:$PATH \

LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (C) 2019-2022 Refinitiv. All rights reserved.
+Copyright (C) 2019-2025 LSEG. All rights reserved.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

README.md

@@ -1,11 +1,11 @@
 # Getting Start Unit Test for an HTTP REST Application with Python
-- version: 1.1
-- Last update: Jan 2023
+- version: 2.0
+- Last update: Feb 2025
 - Environment: Windows
 - Prerequisite: [Access to RDP credentials](#prerequisite)
 
 Example Code Disclaimer:
-ALL EXAMPLE CODE IS PROVIDED ON AN “AS IS” AND “AS AVAILABLE” BASIS FOR ILLUSTRATIVE PURPOSES ONLY. REFINITIV MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND, EXPRESS OR IMPLIED, AS TO THE OPERATION OF THE EXAMPLE CODE, OR THE INFORMATION, CONTENT, OR MATERIALS USED IN CONNECTION WITH THE EXAMPLE CODE. YOU EXPRESSLY AGREE THAT YOUR USE OF THE EXAMPLE CODE IS AT YOUR SOLE RISK.
+ALL EXAMPLE CODE IS PROVIDED ON AN “AS IS” AND “AS AVAILABLE” BASIS FOR ILLUSTRATIVE PURPOSES ONLY. LSEG MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND, EXPRESS OR IMPLIED, AS TO THE OPERATION OF THE EXAMPLE CODE, OR THE INFORMATION, CONTENT, OR MATERIALS USED IN CONNECTION WITH THE EXAMPLE CODE. YOU EXPRESSLY AGREE THAT YOUR USE OF THE EXAMPLE CODE IS AT YOUR SOLE RISK.
 
 ## <a id="intro"></a>Introduction
 
@@ -15,7 +15,7 @@ Unit testing is a software testing method that helps developers verify if any ch
 
 Modern applications also need to connect to other services like APIs, databases, data storage, etc. The unit testing needs to cover those modules too. This example project shows how to run unit test cases for a [Python](https://www.python.org/) application that performs HTTP REST operations which is the most basic task of today's application functionality. With unit testing, developers can verify if their code can connect and consume content via HTTP REST API in any code updates. 
 
-The demo application uses a de-facto [Requests](https://requests.readthedocs.io/en/latest/) library to connect to the [Refinitiv Data Platform (RDP) APIs](https://developers.refinitiv.com/en/api-catalog/refinitiv-data-platform/refinitiv-data-platform-apis) as the example HTTP REST APIs and uses the Python built-in [unittest](https://docs.python.org/3.9/library/unittest.html) as a test framework.
+The demo application uses a de-facto [Requests](https://requests.readthedocs.io/en/latest/) library to connect to the [Delivery Platform (RDP) APIs](https://developers.lseg.com/en/api-catalog/refinitiv-data-platform/refinitiv-data-platform-apis) (formerly known as Refinitiv Data Platform)as the example HTTP REST APIs and uses the Python built-in [unittest](https://docs.python.org/3.9/library/unittest.html) as a test framework.
 
 **Note**:
 This demo project is not cover all test cases for the HTTP operations and all RDP APIs services. It aims to give the readers an idea about how to unit test an application that makes an HTTP connection with Python only. 
@@ -80,23 +80,24 @@ Please find more detail about the unittest framework from the following resource
 - [unittest standard library documentation](https://docs.python.org/3.9/library/unittest.html).
 - [Getting Started With Testing in Python](https://realpython.com/python-testing/).
 
-## <a id="whatis_rdp"></a>What is Refinitiv Data Platform (RDP) APIs?
+## <a id="whatis_rdp"></a>What is Delivery Platform (RDP) APIs?
 
-The [Refinitiv Data Platform (RDP) APIs](https://developers.refinitiv.com/en/api-catalog/refinitiv-data-platform/refinitiv-data-platform-apis) provide various Refinitiv data and content for developers via easy-to-use Web-based API.
+The [RDP APIs](https://developers.lseg.com/en/api-catalog/refinitiv-data-platform/refinitiv-data-platform-apis) provide various LSEG data and content for developers via easy-to-use Web-based API.
 
-RDP APIs give developers seamless and holistic access to all of the Refinitiv content such as Environmental Social and Governance (ESG), News, Research, etc, and commingled with their content, enriching, integrating, and distributing the data through a single interface, delivered wherever they need it.  The RDP APIs delivery mechanisms are the following:
-* Request - Response: RESTful web service (HTTP GET, POST, PUT or DELETE) 
-* Alert: delivery is a mechanism to receive asynchronous updates (alerts) to a subscription. 
-* Bulks:  deliver substantial payloads, like the end-of-day pricing data for the whole venue. 
-* Streaming: deliver real-time delivery of messages.
+RDP APIs give developers seamless and holistic access to all of the LSEG content such as Environmental Social and Governance (ESG), News, Research, etc, and commingled with their content, enriching, integrating, and distributing the data through a single interface, delivered wherever they need it.  The RDP APIs delivery mechanisms are the following:
+
+- Request - Response: RESTful web service (HTTP GET, POST, PUT or DELETE) 
+- Alert: delivery is a mechanism to receive asynchronous updates (alerts) to a subscription. 
+- Bulks:  deliver substantial payloads, like the end-of-day pricing data for the whole venue. 
+- Streaming: deliver real-time delivery of messages.
 
 This example project is focusing on the Request-Response: RESTful web service delivery method only.  
 
-![figure-2](images/02_rdp.png "Refinitiv Data Platform")
+![figure-2](images/02_rdp.png "Delivery Platform")
 
-For more detail regarding the Refinitiv Data Platform, please see the following APIs resources: 
-- [Quick Start](https://developers.refinitiv.com/en/api-catalog/refinitiv-data-platform/refinitiv-data-platform-apis/quick-start) page.
-- [Tutorials](https://developers.refinitiv.com/en/api-catalog/refinitiv-data-platform/refinitiv-data-platform-apis/tutorials) page.
+For more detail regarding the RDP APIs, please see the following APIs resources: 
+- [Quick Start](https://developers.lseg.com/en/api-catalog/refinitiv-data-platform/refinitiv-data-platform-apis/quick-start) page.
+- [Tutorials](https://developers.lseg.com/en/api-catalog/refinitiv-data-platform/refinitiv-data-platform-apis/tutorials) page.
 
 
 ## <a id="testsuite_detail"></a>Test Suit Development Detail
@@ -108,11 +109,11 @@ Please see the full details over the test suite implementation on the [unittest-
 This demo project requires the following dependencies.
 
 1. RDP Access credentials.
-2. Python [Anaconda](https://www.anaconda.com/distribution/) or [MiniConda](https://docs.conda.io/en/latest/miniconda.html) distribution/package manager.
+2. [Python](https://www.python.org/) 3.10 and above
 3. [Docker Desktop/Engine](https://docs.docker.com/get-docker/) application for running the test suite with Docker.
 5. Internet connection.
 
-Please contact your Refinitiv representative to help you to access the RDP account and services. You can find more detail regarding the RDP access credentials set up from the lease see the *Getting Started for User ID* section of the [Getting Start with Refinitiv Data Platform](https://developers.refinitiv.com/en/article-catalog/article/getting-start-with-refinitiv-data-platform) article.
+Please contact your LSEG representative to help you to access the RDP account and services. You can find more detail regarding the RDP access credentials set up from the lease see the *Getting Started for User ID* section of the [Getting Start with Data Platform](https://developers.lseg.com/en/article-catalog/article/getting-start-with-refinitiv-data-platform) article.
 
 
 ## <a id="how_to_run"></a>How to run the example test suite
@@ -121,14 +122,14 @@ The first step is to unzip or download the example project folder into a directo
 
 ### <a id="python_example_run"></a>Run example test suite in a console
 
-1. Open Anaconda Prompt and go to the project's folder.
-2. Run the following command in the Anaconda Prompt application to create a Conda environment named *http_unittest* for the project.
+1. Open a Command Prompt and go to the project's folder.
+2. Run the following command in the Command Prompt application to create a Python Virtual environment named *http_unittest* for the project.
     ```
-    (base) $>conda create --name http_unittest python=3.9
+    $>python -m venv http_unittest
     ```
-3. Once the environment is created, activate a Conda *http_unittest* environment with this command in Anaconda Prompt.
+3. Once the environment is created, activate a virtual environment *http_unittest* environment with this command .
     ```
-    (base) $>conda activate http_unittest
+   $>http_unittest\Script\activate
     ```
 4. Run the following command to the dependencies in the *http_unittest* environment 
     ```
@@ -183,7 +184,7 @@ OK
     ```
     $> docker rm python_unittest
     ```
-![figure-3](images/03_docker_run_result.gif "Refinitiv Data Platform")
+![figure-3](images/03_docker_run_result.gif "Data Platform")
 
 That covers how to run an example test suite.
 
@@ -197,30 +198,31 @@ This example project demonstrates the manual unit testing method. However, devel
 
 The [unittest](https://docs.python.org/3.9/library/unittest.html) framework and [Responses](https://github.com/getsentry/responses) mocking library are very good starting points to learn a unit test with [Python](https://www.python.org/) and build a simple test suite to test HTTP operations source code. If developers need more advanced features, they can explore other Python unit test frameworks such as [pytest](https://docs.pytest.org/en/7.1.x/), [nose2](https://github.com/nose-devs/nose2), or [doctest](https://github.com/doctest/doctest).
 
-At the same time, the [Refinitiv Data Platform (RDP) APIs](https://developers.refinitiv.com/en/api-catalog/refinitiv-data-platform/refinitiv-data-platform-apis) provide various Refinitiv data and content for developers via an easy-to-use Web-based API. The APIs are easy to integrate into any application and platform that supports the HTTP protocol and JSON message format. 
+At the same time, the [RDP APIs](https://developers.lseg.com/en/api-catalog/refinitiv-data-platform/refinitiv-data-platform-apis) provide various LSEG data and content for developers via an easy-to-use Web-based API. The APIs are easy to integrate into any application and platform that supports the HTTP protocol and JSON message format. 
 
 ## <a id="references"></a>References
 
 That brings me to the end of my unit test example project. For further details, please check out the following resources:
-* [Refinitiv Data Platform APIs page](https://developers.refinitiv.com/en/api-catalog/refinitiv-data-platform/refinitiv-data-platform-apis) on the [Refinitiv Developer Community](https://developers.refinitiv.com/) website.
-* [Refinitiv Data Platform APIs Playground page](https://api.refinitiv.com).
-* [Refinitiv Data Platform APIs: Introduction to the Request-Response API](https://developers.refinitiv.com/en/api-catalog/refinitiv-data-platform/refinitiv-data-platform-apis/tutorials#introduction-to-the-request-response-api).
-* [Refinitiv Data Platform APIs: Authorization - All about tokens](https://developers.refinitiv.com/en/api-catalog/refinitiv-data-platform/refinitiv-data-platform-apis/tutorials#authorization-all-about-tokens).
-* [Limitations and Guidelines for the RDP Authentication Service](https://developers.refinitiv.com/en/article-catalog/article/limitations-and-guidelines-for-the-rdp-authentication-service) article.
-* [Getting Started with Refinitiv Data Platform](https://developers.refinitiv.com/en/article-catalog/article/getting-start-with-refinitiv-data-platform) article.
-* [Python unittest framework official page](https://docs.python.org/3/library/unittest.html).
-* [Responses library page](https://github.com/getsentry/responses).
-* [Python Guide: Testing Your Code](https://docs.python-guide.org/writing/tests/) article.
-* [Getting Started With Testing in Python](https://realpython.com/python-testing/) article.
-* [Mocking External APIs in Python](https://realpython.com/testing-third-party-apis-with-mocks/) article.
-* [How To Use unittest to Write a Test Case for a Function in Python](https://www.digitalocean.com/community/tutorials/how-to-use-unittest-to-write-a-test-case-for-a-function-in-python) article.
-* [Mocking API calls in Python](https://auth0.com/blog/mocking-api-calls-in-python/) article.
-* [How and when to use Unit Testing properly](https://softwareengineering.stackexchange.com/questions/89064/how-and-when-to-use-unit-testing-properly) post.
-* [13 Tips for Writing Useful Unit Tests](https://betterprogramming.pub/13-tips-for-writing-useful-unit-tests-ca20706b5368) blog post.
-
-For any questions related to Refinitiv Data Platform APIs, please use the [RDP APIs Forum](https://community.developers.refinitiv.com/spaces/231/index.html) on the [Developers Community Q&A page](https://community.developers.refinitiv.com/).
+
+- [RDP APIs page](https://developers.lseg.com/en/api-catalog/refinitiv-data-platform/refinitiv-data-platform-apis) on the [Refinitiv Developer Community](https://developers.refinitiv.com/) website.
+- [RDP APIs Playground page](https://apidocs.refinitiv.com/Apps/ApiDocs).
+- [RDP APIs: Introduction to the Request-Response API](https://developers.lseg.com/en/api-catalog/refinitiv-data-platform/refinitiv-data-platform-apis/tutorials#introduction-to-the-request-response-api).
+- [RDP APIs - All about tokens](https://developers.lseg.com/en/api-catalog/refinitiv-data-platform/refinitiv-data-platform-apis/tutorials#authorization-all-about-tokens).
+- [Limitations and Guidelines for the RDP Authentication Service](https://developers.lseg.com/en/article-catalog/article/limitations-and-guidelines-for-the-rdp-authentication-service) article.
+- [Getting Started with Data Platform](https://developers.lseg.com/en/article-catalog/article/getting-start-with-refinitiv-data-platform) article.
+- [Python unittest framework official page](https://docs.python.org/3/library/unittest.html).
+- [Responses library page](https://github.com/getsentry/responses).
+- [Python Guide: Testing Your Code](https://docs.python-guide.org/writing/tests/) article.
+- [Getting Started With Testing in Python](https://realpython.com/python-testing/) article.
+- [Mocking External APIs in Python](https://realpython.com/testing-third-party-apis-with-mocks/) article.
+- [How To Use unittest to Write a Test Case for a Function in Python](https://www.digitalocean.com/community/tutorials/how-to-use-unittest-to-write-a-test-case-for-a-function-in-python) article.
+- [Mocking API calls in Python](https://auth0.com/blog/mocking-api-calls-in-python/) article.
+- [How and when to use Unit Testing properly](https://softwareengineering.stackexchange.com/questions/89064/how-and-when-to-use-unit-testing-properly) post.
+- [13 Tips for Writing Useful Unit Tests](https://betterprogramming.pub/13-tips-for-writing-useful-unit-tests-ca20706b5368) blog post.
+
+For any questions related to RDP APIs, please use the [Developers Community Q&A page](https://community.developers.refinitiv.com/).
 
 ## Developers Articles
 
-* [Getting Start Unit Test for an HTTP REST Application with Python](https://developers.refinitiv.com/en/article-catalog/article/getting-start-unit-test-for-an-http-rest-application-with-python) article.
+* [Getting Start Unit Test for an HTTP REST Application with Python](https://developers.lseg.com/en/article-catalog/article/getting-start-unit-test-for-an-http-rest-application-with-python) article.
 * [Getting Start With Unit Test for an HTTP REST Application with Python](https://wasin-waeosri.medium.com/getting-start-unit-test-for-an-http-rest-application-with-python-c57810cc4e56) Medium blog post.

app.py

@@ -2,12 +2,12 @@
 #|            This source code is provided under the MIT license             --
 #|  and is provided AS IS with no warranty or guarantee of fit for purpose.  --
 #|                See the project's LICENSE.md for details.                  --
-#|           Copyright Refinitiv 2022.       All rights reserved.            --
+#|           Copyright LSEG 2025.       All rights reserved.                 --
 #|-----------------------------------------------------------------------------
 
 """
 Example Code Disclaimer:
-ALL EXAMPLE CODE IS PROVIDED ON AN “AS IS” AND “AS AVAILABLE” BASIS FOR ILLUSTRATIVE PURPOSES ONLY. REFINITIV MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND, EXPRESS OR IMPLIED, AS TO THE OPERATION OF THE EXAMPLE CODE, OR THE INFORMATION, CONTENT, OR MATERIALS USED IN CONNECTION WITH THE EXAMPLE CODE. YOU EXPRESSLY AGREE THAT YOUR USE OF THE EXAMPLE CODE IS AT YOUR SOLE RISK.
+ALL EXAMPLE CODE IS PROVIDED ON AN “AS IS” AND “AS AVAILABLE” BASIS FOR ILLUSTRATIVE PURPOSES ONLY. LSEG MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND, EXPRESS OR IMPLIED, AS TO THE OPERATION OF THE EXAMPLE CODE, OR THE INFORMATION, CONTENT, OR MATERIALS USED IN CONNECTION WITH THE EXAMPLE CODE. YOU EXPRESSLY AGREE THAT YOUR USE OF THE EXAMPLE CODE IS AT YOUR SOLE RISK.
 """
 
 import sys

rdp_controller/rdp_http_controller.py

@@ -1,3 +1,15 @@
+#|-----------------------------------------------------------------------------
+#|            This source code is provided under the MIT license             --
+#|  and is provided AS IS with no warranty or guarantee of fit for purpose.  --
+#|                See the project's LICENSE.md for details.                  --
+#|           Copyright LSEG 2025.       All rights reserved.                 --
+#|-----------------------------------------------------------------------------
+
+"""
+Example Code Disclaimer:
+ALL EXAMPLE CODE IS PROVIDED ON AN “AS IS” AND “AS AVAILABLE” BASIS FOR ILLUSTRATIVE PURPOSES ONLY. LSEG MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND, EXPRESS OR IMPLIED, AS TO THE OPERATION OF THE EXAMPLE CODE, OR THE INFORMATION, CONTENT, OR MATERIALS USED IN CONNECTION WITH THE EXAMPLE CODE. YOU EXPRESSLY AGREE THAT YOUR USE OF THE EXAMPLE CODE IS AT YOUR SOLE RISK.
+"""
+
 import requests
 import json
 

requirements.txt

@@ -1,16 +1,14 @@
-certifi==2024.7.4
-charset-normalizer==2.1.0
-idna==3.7
-numpy==1.23.0
-pandas==1.4.3
-pip==23.3
-python-dateutil==2.8.2
-python-dotenv==0.20.0
-pytz==2022.1
-requests==2.32.2
-responses==0.21.0
-setuptools==70.0.0
-six==1.16.0
-urllib3==1.26.9
-wheel==0.38.1
-wincertstore==0.2
+certifi==2025.1.31
+charset-normalizer==3.4.1
+idna==3.10
+numpy==2.2.2
+pandas==2.2.3
+python-dateutil==2.9.0.post0
+python-dotenv==1.0.1
+pytz==2025.1
+PyYAML==6.0.2
+requests==2.32.3
+responses==0.25.6
+six==1.17.0
+tzdata==2025.1
+urllib3==2.3.0