From 0881775ab9688ef893ec0650fba262df8b5f33e9 Mon Sep 17 00:00:00 2001
From: DiptiDhond-Candela
 <67250295+DiptiDhond-Candela@users.noreply.github.com>
Date: Tue, 30 Jun 2020 11:40:17 -0700
Subject: [PATCH] pushing updates currently, another set coming soon

---
 py-scripts/README.md | 53 +++++++++++++++++++++++++++++++++++++-------
 1 file changed, 45 insertions(+), 8 deletions(-)

diff --git a/py-scripts/README.md b/py-scripts/README.md
index fa26061f..69406659 100644
--- a/py-scripts/README.md
+++ b/py-scripts/README.md
@@ -4,20 +4,57 @@ libraries in ../py-json.
 
 #### Scripts included are: 
 
-
 * cicd_TipIntegration.py:
 
 * cicd_testrail.py: 
+ function send_get: Issues a GET request (read) against the API.
+  * function send_post: Issues a write against the API.
+  * function __send_request: 
+  * function get_project_id: Gets the project ID using the project name
+  * function get_run_id: Gets the run ID using test name and project name
+  * function update_testrail: Update TestRail for a given run_id and case_id
 
 * cicd_testrailAndInfraSetup.py:
- 
+  * class GetBuild:
+     * function get_latest_image: extract a tar file from the latest file name from a URL
+     * function run_opensyncgw_in_docker
+     * function run_opensyncgw_in_aws:
+  * class openwrt_linksys:
+    * function ap_upgrade: transfers file from local host to remote host. Upgrade access point with new information (?)
+  * class RunTest
+    * function TestCase_938: checks single client connectivity
+    * function TestCase_941: checks for multi-client connectivity
+    * function TestCase_939: checks for client count in MQTT log and runs the clients (?)
+
 * run_cv_scenario.py:
+   * class RunCvScenario: imports the LFCliBase class.
+    * function get_report_file_name: returns report name
+    * function build: loads and sends the ports available? 
+    * function start: /gui_cli takes commands keyed on 'cmd' and this function create an array of commands
+* sta_connect.py:  This function creates a station, create TCP and UDP traffic, run it a short amount of time,
+  and verify whether traffic was sent and received.  It also verifies the station connected
+  to the requested BSSID if bssid is specified as an argument.
+  The script will clean up the station and connections at the end of the test.
+    * class StaConnect(LFCliBase)
+        * function get_realm: returns the local realm
+        * function get_station_url:
+        * function get_upstream_url:
+        * function compare_vals: compares pre-test values to post-test values
+        * function remove_stations: removes all stations
+        * function num_associated:
+        * function clear_test_results:
+        * function run: 
+        * function setup:
+        * function start:
+        * function stop:
+        * function finish:
+        * function cleanup:
+        * function main:
+* sta_connect2.py: This will create a station, create TCP and UDP traffic, run it a short amount of time,
+  and verify whether traffic was sent and received.  It also verifies the station connected
+  to the requested BSSID if bssid is specified as an argument. The script will clean up the station and connections at the end of the test.
 
-* sta_connect.py:
-
-* sta_connect2.py:
-
-* sta_connect_example.py:
+* sta_connect_example.py: example of how to instantiate StaConnect and run the test
 
 * sta_connect_multi_example.py:
 
@@ -31,6 +68,6 @@ libraries in ../py-json.
 
 * test_wanlink.py:
 
-* vap_stations_example.py:
+* vap_stations_example.py