From f1f1b975ec8c53fb1f801e18a0ebd52b49c94d19 Mon Sep 17 00:00:00 2001
From: Salman Khan <70570645+salmanlt@users.noreply.github.com>
Date: Tue, 7 Jun 2022 06:37:37 +0530
Subject: [PATCH] Updated uniitest readme

---
 README.md | 204 ++++++++++++++++++++++++++++++++++++++++++------------
 1 file changed, 159 insertions(+), 45 deletions(-)

diff --git a/README.md b/README.md
index eb51f7f..b316007 100644
--- a/README.md
+++ b/README.md
@@ -1,77 +1,191 @@
-# Python Unittest Selenium Sample
+# Run Selenium Tests With UnitTest On LambdaTest
 
-![MSTest](https://opengraph.githubassets.com/a8c8c224a50bf052e046550beee8262a40b03a6c3fef1f6448cba546f9f6ce05/LambdaTest/Python-UnitTest-Selenium)
+![171934563-4806efd2-1154-494c-a01d-1def95657383 (1)](https://user-images.githubusercontent.com/70570645/172273386-fa9606ac-3e63-4b2e-8978-3142add3e038.png)
 
-## Prerequisites
 
-1. Install pip and python.
+<p align="center">
+  <a href="https://www.lambdatest.com/blog/?utm_source=github&utm_medium=repo&utm_campaign=python-unittest-selenium" target="_bank">Blog</a>
+  &nbsp; &#8901; &nbsp;
+  <a href="https://www.lambdatest.com/support/docs/?utm_source=github&utm_medium=repo&utm_campaign=python-unittest-selenium" target="_bank">Docs</a>
+  &nbsp; &#8901; &nbsp;
+  <a href="https://www.lambdatest.com/learning-hub/?utm_source=github&utm_medium=repo&utm_campaign=python-unittest-selenium" target="_bank">Learning Hub</a>
+  &nbsp; &#8901; &nbsp;
+  <a href="https://www.lambdatest.com/newsletter/?utm_source=github&utm_medium=repo&utm_campaign=python-unittest-selenium" target="_bank">Newsletter</a>
+  &nbsp; &#8901; &nbsp;
+  <a href="https://www.lambdatest.com/certifications/?utm_source=github&utm_medium=repo&utm_campaign=python-unittest-selenium" target="_bank">Certifications</a>
+  &nbsp; &#8901; &nbsp;
+  <a href="https://www.youtube.com/c/LambdaTest" target="_bank">YouTube</a>
+</p>
+&emsp;
+&emsp;
+&emsp;
 
-```
-sudo apt install python-pip
-sudo apt install python
-```
+*Learn how to run your Python automation testing scripts using UnitTest on the LambdaTest platform*
 
-2. The recommended way to run your tests would be in virtualenv. It will isolate the build from other setups you may have running and ensure that the tests run with the specified versions of the modules specified in the requirements.txt file.
+[<img height="58" width="200" src="https://user-images.githubusercontent.com/70570645/171866795-52c11b49-0728-4229-b073-4b704209ddde.png">](https://accounts.lambdatest.com/register)
 
-```
-pip install virtualenv
-```
 
-## Steps to Run your First Test
+## Table Of Contents
 
-Step 1. Clone the Python-Unittest-Selenium Repository.
+* [Pre-requisites](#pre-requisites)
+* [Run Your First Test](#run-your-first-test)
+* [Local Testing With UnitTest](#testing-locally-hosted-or-privately-hosted-projects)
 
-```
-git clone https://github.com/LambdaTest/Python-UnitTest-Selenium.git
-```
+## Prerequisites To Perform Unit testing In Python with Selenium
+
+Before you can start performing **Python** automation testing using **UnitTest**, you would need to:
+
+* Install the latest Python build from the [official website](https://www.python.org/downloads/). We recommend using the latest version.
+* Make sure **pip** is installed in your system. You can install **pip** from [here](https://pip.pypa.io/en/stable/installation/).
+* Download the latest **Selenium Client** and its **WebDriver bindings** from the [official website](https://www.selenium.dev/downloads/). Latest versions of **Selenium Client** and **WebDriver** are ideal for running your automation script on LambdaTest Selenium cloud grid.
+* Install **virtualenv** which is the recommended way to run your tests. It will isolate the build from other setups you may have running and ensure that the tests run with the specified versions of the modules.
 
-Step 2. Next we create and Activate the virtual environment in the Python-UnitTest-Selenium folder.
+```bash
+pip install virtualenv
+```
+### Installing Selenium Dependencies And Tutorial Repo
 
-For Linux/MacOS
+**Step 1:** Clone the LambdaTest’s Python-UnitTest-Selenium repository and navigate to the code directory as shown below:
+```bash
+git clone https://github.com/LambdaTest/Python-UnitTest-Selenium
+cd Python-UnitTest-Selenium
 ```
+**Step 2:** Create a virtual environment in your project folder the environment name is arbitrary.
+```bash
 virtualenv venv
+```
+**Step 3:** Activate the environment.
+```bash
 source venv/bin/activate
 ```
+**Step 4:** Install the [required packages](https://github.com/LambdaTest/Python-UnitTest-Selenium/blob/master/requirements.txt) from the cloned project directory:
 
-For Windows
-```
-python -m virtualenv venv
-venv\Scripts\activate.bat
+```bash
+pip install -r requirements.txt
 ```
+### Setting Up Your Authentication
 
-Step 3. Then install required packages.
+Make sure you have your LambdaTest credentials with you to run test automation scripts. You can get these credentials from the [LambdaTest Automation Dashboard](https://automation.lambdatest.com/build) or by your [LambdaTest Profile](https://accounts.lambdatest.com/login).
 
-```
-pip install -r requirements.txt
-```
+**Step 5:** Set LambdaTest **Username** and **Access Key** in environment variables.
 
-Step 4. Inside Python-UnitTest-Selenium, export the Lambda-test Credentials. You can get these from your automation dashboard.
+* For **Linux/macOS**:
+  
+  ```bash
+  export LT_USERNAME="YOUR_USERNAME" 
+  export LT_ACCESS_KEY="YOUR ACCESS KEY"
+  ```
+  * For **Windows**:
+  ```bash
+  set LT_USERNAME="YOUR_USERNAME" 
+  set LT_ACCESS_KEY="YOUR ACCESS KEY"
+  ```
 
-<p align="center">
-   <b>For Linux/macOS:</b>
-   
+## Run Your First Test
+
+>**Test Scenario**: The [lambdatest_test.py](https://github.com/LambdaTest/pytest-selenium-sample/blob/master/tests/lt_sample_todo.py) sample script tests a simple to-do application with basic functionalities like mark items as done, add items in a list, calculate total pending items etc.
+
+
+### Configuration of Your Test Capabilities
+
+**Step 6:** In the test script, you need to update your test capabilities. In this code, we are passing browser, browser version, and operating system information, along with LambdaTest Selenium grid capabilities via capabilities object. The capabilities object in the above code are defined as:
+
+```python
+capabilities = {
+        "build": "UnitTest-Selenium-Sample",
+        "name": "UnitTest-Selenium-Test",
+        "platformName": "Windows 11",
+        "browserName": "Chrome",
+        "browserVersion": "latest",
+}
 ```
-export LT_USERNAME="YOUR_USERNAME"
-export LT_ACCESS_KEY="YOUR ACCESS KEY"
+You can generate capabilities for your test requirements with the help of our inbuilt [Desired Capability Generator](https://www.lambdatest.com/capabilities-generator/).
+
+
+### Executing The Test
+
+**Step 7:** Please execute the command below to run your tests:
+```bash
+python lambdatest_test.py
 ```
-<p align="center">
-   <b>For Windows:</b>
-   
+Your test results would be displayed on the test console (or command-line interface if you are using terminal/cmd) and on LambdaTest automation dashboard. [LambdaTest Automation Dashboard](https://automation.lambdatest.com/build) will help you view all your text logs, screenshots and video recording for your entire automation tests.
+
+## Testing Locally Hosted Or Privately Hosted Projects
+
+You can test your locally hosted or privately hosted projects with LambdaTest Selenium grid using LambdaTest Tunnel. All you would have to do is set up an SSH tunnel using tunnel and pass toggle `tunnel = True` via desired capabilities. LambdaTest Tunnel establishes a secure SSH protocol based tunnel that allows you in testing your locally hosted or privately hosted pages, even before they are live.
+
+Refer our [LambdaTest Tunnel documentation](https://www.lambdatest.com/support/docs/testing-locally-hosted-pages/) for more information.
+
+Here’s how you can establish LambdaTest Tunnel.
+
+Download the binary file of:
+* [LambdaTest Tunnel for Windows](https://downloads.lambdatest.com/tunnel/v3/windows/64bit/LT_Windows.zip)
+* [LambdaTest Tunnel for macOS](https://downloads.lambdatest.com/tunnel/v3/mac/64bit/LT_Mac.zip)
+* [LambdaTest Tunnel for Linux](https://downloads.lambdatest.com/tunnel/v3/linux/64bit/LT_Linux.zip)
+
+Open command prompt and navigate to the binary folder.
+
+Run the following command:
+
+```bash
+LT -user {user’s login email} -key {user’s access key}
 ```
-set LT_USERNAME="YOUR_USERNAME"
-set LT_ACCESS_KEY="YOUR ACCESS KEY"
+So if your user name is lambdatest@example.com and key is 123456, the command would be:
+
+```bash
+LT -user lambdatest@example.com -key 123456
 ```
-   
-Step 5. To run your first test.
+Once you are able to connect **LambdaTest Tunnel** successfully, you would just have to pass on tunnel capabilities in the code shown below :
+
+**Tunnel Capability**
+
 ```
-python lambdatest_test.py
+"tunnel" : true
 ```
 
-## See the Results
+## Documentation & Resources :books:
+
+      
+Visit the following links to learn more about LambdaTest's features, setup and tutorials around test automation, mobile app testing, responsive testing, and manual testing.
+
+* [LambdaTest Documentation](https://www.lambdatest.com/support/docs/?utm_source=github&utm_medium=repo&utm_campaign=python-unittest-selenium)
+* [LambdaTest Blog](https://www.lambdatest.com/blog/?utm_source=github&utm_medium=repo&utm_campaign=python-unittest-selenium)
+* [LambdaTest Learning Hub](https://www.lambdatest.com/learning-hub/?utm_source=github&utm_medium=repo&utm_campaign=python-unittest-selenium)    
 
-You can check your test results on the [Automation Dashboard](https://automation.lambdatest.com/build).
-![Automation Testing Logs](https://github.com/LambdaTest/Python-UnitTest-Selenium/dashboard.png)
+## LambdaTest Community :busts_in_silhouette:
 
+The [LambdaTest Community](https://community.lambdatest.com/) allows people to interact with tech enthusiasts. Connect, ask questions, and learn from tech-savvy people. Discuss best practises in web development, testing, and DevOps with professionals from across the globe 🌎
+
+## What's New At LambdaTest ❓
+
+To stay updated with the latest features and product add-ons, visit [Changelog](https://changelog.lambdatest.com/) 
+      
 ## About LambdaTest
 
-[LambdaTest](https://www.lambdatest.com/) is a cloud based selenium grid infrastructure that can help you run automated cross browser compatibility tests on 2000+ different browser and operating system environments. LambdaTest supports all programming languages and frameworks that are supported with Selenium, and have easy integrations with all popular CI/CD platforms. It's a perfect solution to bring your [selenium automation testing](https://www.lambdatest.com/selenium-automation) to cloud based infrastructure that not only helps you increase your test coverage over multiple desktop and mobile browsers, but also allows you to cut down your test execution time by running tests on parallel.
+[LambdaTest](https://www.lambdatest.com/?utm_source=github&utm_medium=repo&utm_campaign=python-unittest-selenium) is a leading test execution and orchestration platform that is fast, reliable, scalable, and secure. It allows users to run both manual and automated testing of web and mobile apps across 3000+ different browsers, operating systems, and real device combinations. Using LambdaTest, businesses can ensure quicker developer feedback and hence achieve faster go to market. Over 500 enterprises and 1 Million + users across 130+ countries rely on LambdaTest for their testing needs.    
+
+### Features
+
+* Run Selenium, Cypress, Puppeteer, Playwright, and Appium automation tests across 3000+ real desktop and mobile environments.
+* Real-time cross browser testing on 3000+ environments.
+* Test on Real device cloud
+* Blazing fast test automation with HyperExecute
+* Accelerate testing, shorten job times and get faster feedback on code changes with Test At Scale.
+* Smart Visual Regression Testing on cloud
+* 120+ third-party integrations with your favorite tool for CI/CD, Project Management, Codeless Automation, and more.
+* Automated Screenshot testing across multiple browsers in a single click.
+* Local testing of web and mobile apps.
+* Online Accessibility Testing across 3000+ desktop and mobile browsers, browser versions, and operating systems.
+* Geolocation testing of web and mobile apps across 53+ countries.
+* LT Browser - for responsive testing across 50+ pre-installed mobile, tablets, desktop, and laptop viewports
+
+    
+[<img height="58" width="200" src="https://user-images.githubusercontent.com/70570645/171866795-52c11b49-0728-4229-b073-4b704209ddde.png">](https://accounts.lambdatest.com/register)
+
+
+      
+## We are here to help you :headphones:
+
+* Got a query? we are available 24x7 to help. [Contact Us](support@lambdatest.com)
+* For more info, visit - [LambdaTest](https://www.lambdatest.com/?utm_source=github&utm_medium=repo&utm_campaign=python-unittest-selenium)
+
