-
Notifications
You must be signed in to change notification settings - Fork 0
/
github_stars.py
222 lines (165 loc) · 7.26 KB
/
github_stars.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
import argparse
import json
import logging
import os
import time
from collections import defaultdict
from contextlib import contextmanager
from dataclasses import dataclass
from typing import Dict, List, Set, Tuple, TypedDict, Union
from github import Github
logger = logging.getLogger(__name__)
@dataclass
class Arguments:
"""Passed in CLI arguments."""
verbose: int
filename: str
write_json: bool
json_filename: str
username: str
class Repo(TypedDict):
"""Github repository details."""
repo_name: str
description: str
url: str
homepage: str
language: str
open_issues: int
stars: int
@contextmanager
def time_it(msg: str):
start = time.perf_counter_ns()
try:
yield
finally:
end = time.perf_counter_ns()
logger.info(f"{msg} took {(end - start) / 1_000_000}ms")
def write_md(
language_to_repos: Dict[str, Repo], filename: str, hidden_languages: Set[str], hidden_repos: Set[str]
) -> None:
"""Write markdown file showcasing a user's github stars."""
with open(filename, "w") as f:
f.write("# ⭐ Stars\n\n")
# Table of Contents
for language in language_to_repos:
if language in hidden_languages:
continue
lang_link = language.lower().replace(" ", "-")
if language == "C++":
lang_link = "c-1"
elif language == "C#":
lang_link = "c-2"
f.write(f"- [{language}](#{lang_link})\n")
# Language sections
for language in language_to_repos:
if language in hidden_languages:
continue
f.write(f"\n# {language}\n\n")
for repo in sorted(language_to_repos[language], key=lambda x: x["stars"], reverse=True):
if repo["repo_name"] in hidden_repos:
continue
description = f" - {repo['description']}" if repo["description"] is not None else ""
f.write(f"- ⭐{repo['stars']} [{repo['repo_name']}]({repo['url']}){description}\n")
def update_with_overrides(repo_name_to_repo: Dict[str, Repo], overrides: Dict[str, Repo]) -> None:
"""Update repos with override values."""
for repo_name in repo_name_to_repo.keys() & overrides.keys():
repo_name_to_repo[repo_name].update(overrides[repo_name])
def get_repo_overrides() -> Dict[str, Union[List[str], Dict[str, Repo]]]:
"""Get repo overrides from overrides.json"""
with open("overrides.json", "r") as f:
repo_overrides = json.load(f)
logger.debug(f"repo_overrides = {repo_overrides}")
return repo_overrides
def write_json(repo_name_to_repo: Dict[str, Repo], json_filename: str) -> None:
"""Write repo_name_to_repo to file as json."""
with open(json_filename, "w") as f:
json.dump(repo_name_to_repo, f, indent=4)
def index_starred_repos(repos: List[Repo]) -> Tuple[Dict[str, Repo], Dict[str, Repo]]:
"""Index repos by repo name and language."""
# Create datastructures from retrieved repo data
repo_name_to_repo = {}
language_to_repos: defaultdict[str, list] = defaultdict(list)
for repo in repos:
repo_name_to_repo[repo["repo_name"]] = repo
language = repo["language"] if repo["language"] is not None else "Txt"
language_to_repos[language].append(repo)
# Sort the dictionary
language_to_repos = dict(sorted(language_to_repos.items()))
logger.debug(f"repo_name_to_repo = {repo_name_to_repo}")
logger.debug(f"language_to_repos = {language_to_repos}")
return repo_name_to_repo, language_to_repos
def get_starred_repos(username: str) -> List[Repo]:
"""Get starred repos for given username from Github API."""
g = Github(os.environ.get("GIT_TOKEN", ""))
with time_it("get_user"):
user = g.get_user(username)
with time_it("get_starred"):
starred_repos = user.get_starred()
logger.debug(f"starred_repos = {starred_repos}")
# Retrieve repo data from github api
repos: List[Repo] = []
with time_it("enumerate paginated repos"):
for repo in starred_repos:
repos.append(
Repo(
repo_name=repo.full_name,
description=repo.description,
url=repo.html_url,
homepage=repo.homepage,
language=repo.language,
open_issues=repo.open_issues,
stars=repo.stargazers_count,
)
)
logger.debug(f"repos = {repos}")
return repos
@time_it("github_stars.py")
def main(args: Arguments) -> None:
"""Main processing logic."""
repos = get_starred_repos(args.username)
logger.info(f"retrieved starred repos for user {args.username}")
repo_name_to_repo, language_to_repos = index_starred_repos(repos)
logger.info(f"indexed repos by repo name and language")
if args.write_json:
write_json(repo_name_to_repo, args.json_filename)
logger.info(f"wrote repo_name_to_repo to {args.json_filename}")
repo_overrides = get_repo_overrides()
logger.info("retrieved repo_overrides")
hidden_languages = set(repo_overrides.get("hidden_languages", []))
logger.debug(f"hidden_languages = {hidden_languages}")
logger.info("hidden_languages converted to set")
hidden_repos = set(repo_overrides.get("hidden_repos", []))
logger.debug(f"hidden_repos = {hidden_repos}")
logger.info("hidden_repos converted to set")
update_with_overrides(repo_name_to_repo, repo_overrides.get("overrides", {}))
logger.debug(f"repo_name_to_repo after update_existing = {repo_name_to_repo}")
logger.info("updated repo_name_to_repo with repo_overrides['overrides']")
write_md(language_to_repos, args.filename, hidden_languages, hidden_repos)
logger.info(f"wrote markdown file {args.filename}")
def config_logger(verbosity: int):
"""Configure logging script."""
levels = [logging.WARNING, logging.INFO, logging.DEBUG]
level = levels[min(verbosity, len(levels) - 1)] # cap to last level index
formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
file_handler = logging.FileHandler("github_stars.log")
file_handler.setFormatter(formatter)
console_handler = logging.StreamHandler()
console_handler.setFormatter(formatter)
root_logger = logging.getLogger()
root_logger.setLevel(level)
root_logger.addHandler(file_handler)
root_logger.addHandler(console_handler)
def parse_args() -> Arguments:
"""Parse CLI arguments."""
parser = argparse.ArgumentParser(description="Create markdown file showcasing a user's github stars.")
parser.add_argument("-v", "--verbose", action="count", default=0)
parser.add_argument("-f", "--filename", default="stars.md", help="Output markdown filename.")
parser.add_argument("-j", "--json", action="store_true", help="Write json file with starred repo data.")
parser.add_argument("-jf", "--json-filename", default="github_stars.json", help="Output json filename.")
parser.add_argument("username", help="User to extract stars from.")
args = parser.parse_args()
return Arguments(args.verbose, args.filename, args.json, args.json_filename, args.username)
if __name__ == "__main__":
args = parse_args()
config_logger(args.verbose)
main(args)