Resovled requested changes

Author: vybhav72954

Python/Github_Traffic/README.md

@@ -3,7 +3,7 @@
 This script, can help one determine all the unique viewers on his/her Repository.
 By using `access-token` one can determine the viewers and number of time they viewed the Repo.
 Currently data of only 14 days is possible (limitation of GitHib-API), but in future by using the GraphQL queries, this limitation can be answered.
-Te script uses PickleDB, the data can be imported in CSV as well, although the functionality hasn't been added till this point of time.
+The script uses PickleDB, the data can be imported in CSV as well, although the functionality hasn't been added till this point of time.
 
 ## Note
 
@@ -20,12 +20,12 @@ These are summarised in `requirement.txt`
 
 ## Setup
 
-1. A virtual environment (recommended)
-1. `pip install -r requirements.txt`
-1. Generate your own access token from [here](https://github.com/settings/tokens) (If you already have one with `repo` rights, it can be used as well)
-1. It is recommended to paste this token somewhere, as one cant review it again.
-1. Determine the Repository whose traffic you want to view.
-1. Run the Script
+- A virtual environment (recommended)
+- `pip install -r requirements.txt`
+- Generate your own access token from [here](https://github.com/settings/tokens) (If you already have one with `repo` rights, it can be used as well)
+- It is recommended to paste this token somewhere, as one cant review it again.
+- Determine the Repository whose traffic you want to view.
+- Run the Script
 
 ## Usage
 

Python/Github_Traffic/github_traffic.py

@@ -4,8 +4,18 @@
 import argparse
 import sys
 
-# Collect Information for Databse
+
 def collect(user, repo, token, org):
+    """
+    Function for Collection of Data.
+    Counts the total number of views (Unique and total) on a Repo.
+
+    Parameters:
+        user (str): The Github Username
+        repo (str): The Name of Repo
+        token (str): The Personal Access Token
+        org (str): The Name of Organization [Optional]
+    """
     if org is None:
         org = user
 
@@ -45,6 +55,12 @@ def collect(user, repo, token, org):
 
 
 def view(repo):
+    """
+    Function for viewing the Results obtained in the collect function
+
+    Parameters:
+        repo (str): Name of the Repo
+    """
     db = __load_db(repo=repo)
     timestamps = db.getall()
     for ts in sorted(timestamps):
@@ -53,6 +69,13 @@ def view(repo):
 
 
 def __load_db(repo):
+    """
+    The attribute to Load the information present in the Database
+
+    Parameters:
+        repo (str): The name of the Repo
+    """
+
     return pickledb.load('{repo}_views.db'.format(repo=repo), False)
 
 
@@ -80,4 +103,4 @@ def main():
 
 
 if __name__ == "__main__":
-    main()
+    main()