-
-
Notifications
You must be signed in to change notification settings - Fork 5
/
main.py
188 lines (171 loc) · 7.32 KB
/
main.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
import requests
from datetime import date, timedelta
import requests_cache
from requests_cache import CachedSession
import re
from github import Github
import os
from dotenv import load_dotenv
load_dotenv()
requests_cache.install_cache('gh_cache', expire_after=timedelta(days=7))
s = CachedSession(expire_after=timedelta(days=7))
def on_pre_page_macros(env):
html = ''
repo_name = env.page.meta.get('repo_name')
contributors = env.page.meta.get('contributors', [])
contributors_exclude = env.page.meta.get('contributors_exclude', [])
# print(repo_name)
headers = {'Authorization': f'token {os.getenv("GITHUB_TOKEN")}'}
if repo_name:
g = Github(os.getenv("GITHUB_TOKEN"))
repo = g.get_repo(f'GLAM-Workbench/{repo_name}')
for user in repo.get_contributors():
user_name = None
if user.name:
user_name = user.name
elif not user.login.startswith('github-'):
user_name = user.login
if user_name and user_name not in contributors_exclude:
contributors.append({"name": user_name, "url": user.html_url})
env.page.meta['contributors'] = contributors
try:
r = s.get(f'https://api.github.com/repos/glam-workbench/{repo_name}', timeout=30, headers=headers)
except requests.exceptions.RequestException:
print('Could not get data from GitHub!')
data = {}
else:
data = r.json()
stars = data.get('stargazers_count')
forks = data.get('forks_count')
try:
r = s.get(f'https://api.github.com/repos/glam-workbench/{repo_name}/releases', timeout=30, headers=headers)
except requests.exceptions.RequestException:
print('Could not get data from GitHub!')
else:
releases = r.json()
try:
tag = releases[0]['tag_name']
link = releases[0]['html_url']
except (KeyError, IndexError):
# print(releases)
tag = ''
link = ''
if tag:
html += f'<li class="md-source__fact md-source__fact--version">{tag}</li>'
if stars:
html += f'<li class="md-source__fact md-source__fact--stars">{stars}</li>'
if forks:
html += f'<li class="md-source__fact md-source__fact--forks">{forks}</li>'
env.page.meta['repo_stats'] = html
env.page.meta['version'] = tag
env.page.meta['version_url'] = link
zenodo_id = env.page.meta.get('zenodo_concept_id')
if zenodo_id:
try:
r = s.get(f'https://zenodo.org/api/records/{zenodo_id}', timeout=30)
except requests.exceptions.RequestException:
print('Could not get data from Zenodo!')
else:
details = r.json()
doi = details['links']['doi']
badge = details['links']['badge']
# fdate = date.fromisoformat(details['metadata']['publication_date']).strftime('%-d %B %Y')
fdate = date.fromisoformat(details['metadata']['publication_date']).strftime('%Y')
title = details['metadata']['title']
version = details['metadata']['version']
authors = [c['name'] for c in details['metadata']['creators']]
if len(authors) == 2:
author_str = f'{authors[0]} & {authors[1]}'
elif len(authors) > 2:
author_str = f'{"; ".join(authors[:-1])} & {authors[-1]}'
else:
author_str = authors[0]
env.page.meta["doi"] = doi
env.page.meta["badge"] = badge
env.page.meta["pub_date"] = details['metadata']['publication_date']
env.page.meta["zenodo_title"] = title
env.page.meta["version"] = version
env.page.meta["authors"] = authors
env.page.meta["citation"] = f'{author_str}. ({fdate}). {title} (version {version}). Zenodo. [{doi}]({doi})' + ' \n\n' + f'[]({doi})'
def define_env(env):
"Hook function"
@env.macro
def zenodo_citation():
return env.page.meta.get("citation", "")
@env.macro
def git_latest_tag():
version = ''
version_tag = env.page.meta.get('version')
version_link = env.page.meta.get('version_url')
if version_tag and version_link:
version = f'##### Current version: [{version_tag}]({version_link}) {{: data-toc-omit }}'
elif version_tag:
version = f'##### Current version: {version_tag} {{: data-toc-omit }}'
return version
@env.macro
def set_repo_stats():
return env.page.meta.get("repo_stats", "")
@env.macro
def repo_contributors():
md = ''
g = Github(os.getenv("GITHUB_TOKEN"))
repo = g.get_repo(f'GLAM-Workbench/{env.page.meta.get("repo_name")}')
for user in repo.get_contributors():
if user.name:
md += f'* [{user.name}]({user.html_url})\n'
elif not user.login.startswith('github-'):
md += f'* [{user.login}]({user.html_url})\n'
return md
@env.macro
def documentation_contributors():
md = ''
g = Github(os.getenv("GITHUB_TOKEN"))
repo = g.get_repo(f'GLAM-Workbench/{env.conf["repo_name"]}')
for user in repo.get_contributors():
if user.name:
md += f'* [{user.name}]({user.html_url})\n'
elif not user.login.startswith('github-'):
md += f'* [{user.login}]({user.html_url})\n'
return md
@env.macro
def code_contributors():
users = []
g = Github(os.getenv("GITHUB_TOKEN"))
org = g.get_organization(f'GLAM-Workbench')
for repo in org.get_repos(type='public'):
if not repo.fork:
for user in repo.get_contributors():
if user.name:
users.append(f'* [{user.name}]({user.html_url})')
elif not user.login.startswith('github-'):
users.append(f'* [{user.login}]({user.html_url})')
return ('\n').join(list(set(users)))
# Code below modified from https://github.com/mercari/mkdocs-git-snippet
def get_markdown_section(content: str, section: str) -> str:
section_pattern = re.compile("^#+ ")
match = section_pattern.search(section)
if not match:
raise ValueError(f"Invalid section name: {section}")
section_level = match.span()[1] - 1
target = re.compile("^" + section + "$", re.MULTILINE)
start = target.search(content)
if not start:
raise ValueError(f"Not found: {section}")
start_index = start.span()[1]
end_target = re.compile("^#{1," + str(section_level) + "} ", re.MULTILINE)
end = end_target.search(content[start_index:])
if end:
end_index = end.span()[0]
content = content[start_index : end_index + start_index]
else:
content = content[start_index:]
return content
@env.macro
def gitsnippet(repository: str, file: str, section: str) -> str:
g = Github(os.getenv("GITHUB_TOKEN"))
repo = g.get_repo(repository)
f = repo.get_contents(file)
content = f.decoded_content.decode("utf-8")
if section:
content = get_markdown_section(content, section)
return content