Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Correction/ Updation of README.md 
1. Adjusting the meanings of python scripts.
2. Adjusting commands required to run the scripts successfully.
  • Loading branch information
niccolopaganini authored Sep 23, 2023
1 parent e89be84 commit a7ea912
Showing 1 changed file with 11 additions and 15 deletions.
26 changes: 11 additions & 15 deletions bin/API_migration_scripts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,12 @@ This README allows one to successfully run to the API Migration Automation scrip
## File(s) Description

### Python Scripts
| .py | Description |
| ------------- | ------------- |
| classes | scrapes packages/ classes |
| modified_csv | removes unnecessary info |
| unique_classes | compiles a unique list from the above |
| simplify_classes | removes unnecessary from the above |
| output | compares the above csv with all the plugins form the given directory |
| unique_packages | removes the path column and compiles a unique list |
| links | scrapes similar to classes but stores them as URLs |
| simplified_links | removes unnecessary info |
| changed_scraped | gets the methods with the URLs and desc. |
| changed_scraped_without_column | filters to the methods|
| matching_entries | gets the matching packages |
| merged_output | gets the name of the packages, file location, and method name (as a whole) |
| .py | Description |
| ----------------- | -------------------------------------------------------------------------------------------------- |
| c1_m2_u3_s4 | Scrapes packages on a high level and compiles a list of just classes |
| o5_up6 | Takes the above list and compares against the `plugins` directory and then compiles a list. This list is then distilled to hold just a unique pair |
| l7_sl8_cs9_cswc10 | Scrapes the URL again and saves them as links. With the list, I use it to access each link and compile ONLY the changes. Then I filter it to just unique methods |
| me11_mo12 | Takes the above and the `unique_packages.csv` and then compares to get a list in `merged_output.csv` which contains the final list of methods requiring some form of change |

The above python scripts creates the following CSVs

Expand All @@ -45,6 +37,8 @@ The above python scripts creates the following CSVs

![CSV_Files_Importance](https://github.com/niccolopaganini/e-mission-phone-nvsr-iter1/blob/16b6ba09b3e6dc37e0927b6ff338400e3236e28b/bin/API_migration_scripts/screenshots/CSVs.png)

The files colored in purple can be used for reference and the file highlighted with contain the output. The bash file `API_cf.sh` will delete the unnecessary CSVs

## Setup/ How to run

### Setup
Expand All @@ -63,8 +57,10 @@ https://developer.android.com/sdk/api_diff/33/changes/alldiffs_index_changes

__3. This command runs the shell script which in turn executes the python scripts__
```
bash bash API_cf.sh.sh
bash API_cf.sh.sh
```
Paste the link you copied and give it a few minutes to run the entire script

## Expected Output
Excepted Output will be a CSV file (```merged_output.csv```). The file opened in an excel will be in the following format:
```
Expand Down

0 comments on commit a7ea912

Please sign in to comment.