Added an Environment Var for PAT

Author: vybhav72954

Python/Github_Traffic/.env.example

@@ -0,0 +1,3 @@
+API_KEY="XXXXXXXXXXXXX"
+
+// Here you have to save your own Private Access Token which will be used in Main code to fetch the data

Python/Github_Traffic/README.md

@@ -14,6 +14,7 @@ This script can be converted in a Bot, Action or GitHub app!!!
 
 - githubpy
 - PickleDB
+- python-decouple
 
 These are summarised in `requirement.txt`
 
@@ -22,8 +23,9 @@ These are summarised in `requirement.txt`
 
 - 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.
+- Generate your own access token from [here](https://github.com/settings/tokens)
+- Paste the token in a `.env` file (Take [`.env.example`](.env.example) as an example)
+- It is recommended to paste this token somewhere, as one can't review it again.
 - Determine the Repository whose traffic you want to view.
 - Run the Script
 
@@ -32,7 +34,7 @@ These are summarised in `requirement.txt`
 Sample Usage -
 
 `
-python github_traffic.py collect -u vybhav72954 -r Music-Mood-Analysis -t *********
+python github_traffic.py collect -u vybhav72954 -r Music-Mood-Analysis
 `
 
 Output -
@@ -52,13 +54,13 @@ Generalized Usage -
 - collect (Collect Information for first time in Database)
 
 `
-python3 github_traffic.py collect -u [github-user] -r [github-repo] -t [github-access-token]
+python3 github_traffic.py collect -u [github-user] -r [github-repo]
 `
 
 - view (View Information already stored in Database)
 
 `
-python3 github_traffic.py view -u [github-user] -r [github-repo] -t [github-access-token]
+python3 github_traffic.py view -u [github-user] -r [github-repo]
 `
 
 `

Python/Github_Traffic/github_traffic.py

@@ -3,54 +3,53 @@
 import json
 import argparse
 import sys
+import decouple
 
 
-def collect(user, repo, token, org):
+def collect(user, repo, 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]
     """
+
+    token = decouple.config("API_KEY")
     if org is None:
         org = user
 
     db = __load_db(repo=repo)
-
-    # Connect API using PAT
     gh = github.GitHub(access_token=token)
     try:
         gh.repos(org, repo).get()
     except Exception:
-        sys.exit('No Data')
+        sys.exit("No Data")
 
     if user is not None and org != user:
         try:
             gh.repos(org, repo).collaborators(user).get()
         except Exception:
-            sys.exit('No Data')
-
+            sys.exit("No Data")
     views_data = gh.repos(org, repo).traffic.views.get()
     found_new_data = False
-    for view_per_day in views_data['views']:
-        timestamp = view_per_day['timestamp']
-        data = {'uniques': view_per_day['uniques'], 'count': view_per_day['count']}
+    for view_per_day in views_data["views"]:
+        timestamp = view_per_day["timestamp"]
+        data = {"uniques": view_per_day["uniques"], "count": view_per_day["count"]}
         if db.get(timestamp) is None or db.get(timestamp) is False:
             db.set(timestamp, json.dumps(data))
             print(timestamp, data)
             found_new_data = True
         else:
             db_data = json.loads(db.get(timestamp))
-            if db_data['uniques'] < data['uniques']:
+            if db_data["uniques"] < data["uniques"]:
                 db.set(timestamp, json.dumps(data))
                 print(timestamp, data)
                 found_new_data = True
     if not found_new_data:
-        print('No Data')
+        print("No new traffic data was found for " + org + "/" + repo)
     db.dump()
 
 
@@ -61,11 +60,12 @@ def view(repo):
     Parameters:
         repo (str): Name of the Repo
     """
+
     db = __load_db(repo=repo)
     timestamps = db.getall()
     for ts in sorted(timestamps):
         print(ts, db.get(ts))
-    print(len(timestamps), 'elements')
+    print(len(timestamps), "elements")
 
 
 def __load_db(repo):
@@ -76,30 +76,41 @@ def __load_db(repo):
         repo (str): The name of the Repo
     """
 
-    return pickledb.load('{repo}_views.db'.format(repo=repo), False)
+    return pickledb.load("{repo}_views.db".format(repo=repo), False)
 
 
 def main():
+    """
+    Function for Argument Parsing
+    :return:
+    user : Github username
+    repo : Name of Repository
+    org : Organization
+    """
     parser = argparse.ArgumentParser()
-    parser.add_argument('action', choices=['collect', 'view'])
-    parser.add_argument('-u', '--github_user', action='store')
-    parser.add_argument('-t', '--github_access_token', action='store')
-    parser.add_argument('-o', '--github_org', action='store')
-    parser.add_argument('-r', '--github_repo', action='store')
-    parser.add_argument('-v', '--view', help='view DB content', action='store_true')
+    parser.add_argument("action", choices=["collect", "view"])
+    parser.add_argument("-u", "--github_user", action="store")
+    parser.add_argument("-o", "--github_org", action="store")
+    parser.add_argument("-r", "--github_repo", action="store")
+    parser.add_argument("-v", "--view", help="view DB content", action="store_true")
 
     args = parser.parse_args()
 
-    if args.action == 'view':
+    if args.action == "view":
         if args.github_repo is None:
-            sys.exit('You need to provide GitHub repo: -r|--github_repo')
+            sys.exit("You need to provide GitHub repo: -r|--github_repo")
         view(repo=args.github_repo)
     else:
-        if (args.github_repo is None or
-           args.github_access_token is None or
-           (args.github_user is None and args.github_org is None)):
-            sys.exit('Recheck all the arguments, view README\n')
-        collect(user=args.github_user, repo=args.github_repo, token=args.github_access_token, org=args.github_org)
+        if args.github_repo is None or (
+            args.github_user is None and args.github_org is None
+        ):
+            sys.exit(
+                "Recheck all the arguments, view README\n"
+                "Please provide all of the following:\n"
+                "  GitHub user/org:      -u|--github_user AND/OR -o|--github_org\n"
+                "  GitHub repo:          -r|--github_repo\n"
+            )
+        collect(user=args.github_user, repo=args.github_repo, org=args.github_org)
 
 
 if __name__ == "__main__":

Python/Github_Traffic/requirement.txt

@@ -1,3 +1,4 @@
 githubpy==1.1.0
 pickleDB==0.9.2
-simplejson==3.17.0
+simplejson==3.17.0
+python-decouple==3.4