GitHub Traffic

Author: vybhav72954

Python/Github_Traffic/README.md

@@ -0,0 +1,85 @@
+# Human_Detector
+
+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.
+
+## Note
+
+This script can be converted in a Bot, Action or GitHub app!!!
+
+
+## Dependency
+
+- githubpy
+- PickleDB
+
+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
+
+## Usage
+
+Sample Usage -
+
+`
+python github_traffic.py collect -u vybhav72954 -r Music-Mood-Analysis -t *********
+`
+
+Output -
+
+`
+2020-12-20T00:00:00Z {'uniques': 1, 'count': 1}
+2020-12-24T00:00:00Z {'uniques': 2, 'count': 17}
+2020-12-25T00:00:00Z {'uniques': 1, 'count': 4}
+2020-12-27T00:00:00Z {'uniques': 1, 'count': 1}
+2020-12-28T00:00:00Z {'uniques': 1, 'count': 23}
+2020-12-29T00:00:00Z {'uniques': 1, 'count': 1}
+2020-12-30T00:00:00Z {'uniques': 1, 'count': 3}
+2020-12-31T00:00:00Z {'uniques': 1, 'count': 7}
+`
+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]
+`
+
+- view (View Information already stored in Database)
+
+`
+python3 github_traffic.py view -u [github-user] -r [github-repo] -t [github-access-token]
+`
+
+`
+2020-12-20T00:00:00Z {"uniques": 1, "count": 1}
+2020-12-24T00:00:00Z {"uniques": 2, "count": 17}
+2020-12-25T00:00:00Z {"uniques": 1, "count": 4}
+2020-12-27T00:00:00Z {"uniques": 1, "count": 1}
+2020-12-28T00:00:00Z {"uniques": 1, "count": 23}
+2020-12-29T00:00:00Z {"uniques": 1, "count": 1}
+2020-12-30T00:00:00Z {"uniques": 1, "count": 3}
+2020-12-31T00:00:00Z {"uniques": 1, "count": 7}
+8 elements
+`
+
+## Disclaimer
+
+- `githubpy` is a 8 year old package and is no longer maintained
+- Inspired by [this](https://github.com/seladb/github-traffic-stats/blob/master/README.md)
+
+
+## Author(s)  
+
+Made by [Vybhav Chaturvedi](https://www.linkedin.com/in/vybhav-chaturvedi-0ba82614a/)
+

Python/Github_Traffic/github_traffic.py

@@ -0,0 +1,83 @@
+import github
+import pickledb
+import json
+import argparse
+import sys
+
+# Collect Information for Databse
+def collect(user, repo, token, org):
+    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')
+
+    if user is not None and org != user:
+        try:
+            gh.repos(org, repo).collaborators(user).get()
+        except Exception:
+            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']}
+        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']:
+                db.set(timestamp, json.dumps(data))
+                print(timestamp, data)
+                found_new_data = True
+    if not found_new_data:
+        print('No Data')
+    db.dump()
+
+
+def view(repo):
+    db = __load_db(repo=repo)
+    timestamps = db.getall()
+    for ts in sorted(timestamps):
+        print(ts, db.get(ts))
+    print(len(timestamps), 'elements')
+
+
+def __load_db(repo):
+    return pickledb.load('{repo}_views.db'.format(repo=repo), False)
+
+
+def main():
+    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')
+
+    args = parser.parse_args()
+
+    if args.action == 'view':
+        if args.github_repo is None:
+            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 __name__ == "__main__":
+    main()

Python/Github_Traffic/requirement.txt

@@ -0,0 +1,3 @@
+githubpy==1.1.0
+pickleDB==0.9.2
+simplejson==3.17.0