-
Notifications
You must be signed in to change notification settings - Fork 3
/
covid_report.py
331 lines (250 loc) · 9.42 KB
/
covid_report.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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
#! /usr/bin/env python
from datetime import datetime, timedelta
import hb_config
import mwapi
from mwapi.errors import APIError
import requests
from requests_oauthlib import OAuth1
import pandas as pd
import json
#TODO
#encapsulate what's in MAIN
#pull hard-coded vals to hb_config
#docstrings
#rmv my dumb API function
#code from https://.com/mediawiki-utilities/python-mwapi
def get_template_mems(template):
# If passed a `continuation` parameter, returns an iterable over a continued query.
# On each iteration, a new request is made for the next portion of the results.
continued = session.get(
formatversion=2,
action='query',
generator='transcludedin',
gtinamespace = "0",
gtiprop= "title",
gtishow = "!redirect",
titles= template,
gtilimit=500, # 100 results per request
continuation=True)
pages = []
try:
for portion in continued:
if 'query' in portion:
for page in portion['query']['pages']:
pages.append(page['title'])
else:
print("MediaWiki returned empty result batch.")
except APIError as error:
raise ValueError(
"MediaWiki returned an error:", str(error)
)
return pages
def api_call(endpoint, parameters): #I don't need this
try:
call = requests.get(endpoint, params=parameters)
response = call.json()
except:
response = None
return response
def get_latest_rev(page_title):
#https://en.wikipedia.org/w/api.php?action=parse&prop=sections&format=json&formatversion=2&page=Whidbey_Island
ENDPOINT = 'https://en.wikipedia.org/w/api.php'
params = {'action' : 'query',
'prop' : 'revisions',
'titles' : page_title,
'format' : 'json',
'formatversion' : 2,
}
page_data = api_call(ENDPOINT, params)
# pprint(page_data)
try:
latest_rev = page_data['query']['pages'][0]['revisions'][0]['revid']
except:
print("unable to retrieve latest revision for " + page_title)
latest_rev = None
return latest_rev
def get_quality_score(revision):
#https://ores.wikimedia.org/v3/scores/enwiki/866126465/wp10?features=true
ENDPOINT = 'https://ores.wikimedia.org/v3/scores/enwiki/'
params = {'models' : 'wp10',
'revids' : revision,
}
page_data = api_call(ENDPOINT, params)
# pprint(page_data)
try:
prediction = page_data['enwiki']['scores'][str(revision)]['wp10']['score']['prediction']
# print(prediction)
except:
print("unable to retrieve ORES score for " + str(revision))
prediction = None
return prediction
def get_pageviews(article_params):
#sample https://wikimedia.org/api/rest_v1/metrics/pageviews/per-article/en.wikipedia.org/all-access/user/Zeng_Guang/daily/20200314/20200314
q_template= "https://wikimedia.org/api/rest_v1/metrics/pageviews/per-article/en.wikipedia.org/all-access/user/{title}/daily/{startdate}/{enddate}"
q_string = q_template.format(**article_params)
# print(q_string)
# r = requests.get(q_string)
r = requests.get(
url = q_string,
headers = {'User-Agent': "hostbot (https://wikitech.wikimedia.org/wiki/Tool:HostBot, jonnymorgan.esq@gmail.com"},
)
# print(r.headers)
# print(r.text)
# print(r.url)
response = r.json()
# print(response)
try:
views = response['items'][0]['views']
except:
views = None
return views
def get_yesterdates():
"""
Returns month, day year for yesterday; month and day for day before
"""
date_parts = {'year': datetime.strftime(datetime.now() - timedelta(1), '%Y'),
'month' : datetime.strftime(datetime.now() - timedelta(1), '%m'),
'day': datetime.strftime(datetime.now() - timedelta(1), '%d'),
'month2' : datetime.strftime(datetime.now() - timedelta(2), '%m'),
'day2': datetime.strftime(datetime.now() - timedelta(2), '%d'),
}
return date_parts
def get_total_pageviews(df, column_key):
"""
Return sum of numeric column from dataframe based on column title
"""
total_views = df[column_key].sum()
return total_views
def format_row(rank, title, views, prediction, row_template):
table_row = {'view rank': rank,
'title' : title.replace("_"," "),
'views' : views,
'prediction' : prediction,
}
row = row_template.format(**table_row)
# print(row)
return(row)
def get_token(auth1):
"""
Accepts an auth object for a user
Returns an edit token for the specified wiki
"""
result = requests.get(
url="https://en.wikipedia.org/w/api.php", #TODO add to config
params={
'action': "query",
'meta': "tokens",
'type': "csrf",
'format': "json"
},
headers={'User-Agent': "hostbot (https://wikitech.wikimedia.org/wiki/Tool:HostBot, jonnymorgan.esq@gmail.com"}, #TODO add to config
auth=auth1,
).json()
# print(result)
edit_token = result['query']['tokens']['csrftoken']
# print(edit_token)
return(edit_token)
def publish_report(output, edit_sum, auth1, edit_token):
"""
Accepts the page text, credentials and edit token
Publishes the formatted page text to the specified wiki
"""
response = requests.post(
url = "https://en.wikipedia.org/w/api.php", #TODO add to config
data={
'action': "edit",
'title': "Wikipedia:WikiProject_COVID-19/Article_report", #TODO add to config
'section': "1",
# 'summary': edit_sum,
'summary': edit_sum,
'text': output,
'bot': 1,
'token': edit_token,
'format': "json"
},
headers={'User-Agent': "jonnymorgan.esq@gmail.com"}, #TODO add to config
auth=auth1
)
if __name__ == "__main__":
auth1 = OAuth1("b5d87cbe96174f9435689a666110159c",
hb_config.client_secret,
"ca1b222d687be9ac33cfb49676f5bfd2",
hb_config.resource_owner_secret)
session = mwapi.Session('https://en.wikipedia.org/', user_agent="hostbot (https://wikitech.wikimedia.org/wiki/Tool:HostBot, jonnymorgan.esq@gmail.com") #add ua to config
#get yesterday's date info for queries and reporting
date_parts = get_yesterdates()
cat = 'Template:COVID-19_pandemic'
mems = get_template_mems(cat)
# print(mems)
#put these in a dataframe
df_pandemic = pd.DataFrame(mems)
df_pandemic.rename(columns = {0 : 'page title'}, inplace=True) #should do this when we create the df
latest_revs = []
scores = []
for row in df_pandemic['page title']:
# print(dfd_test['event_pageTitle'])
# print(get_latest_rev(row))
latest = get_latest_rev(row)
latest_revs.append(latest)
scores.append(get_quality_score(latest))
#Add the scores and revs into the dataframe
lrs = pd.Series(latest_revs)
ss = pd.Series(scores)
df_pandemic.insert(loc=1, column = 'latest revision', value = lrs)
df_pandemic.insert(loc=2, column = 'quality prediction', value = ss)
#get recent pageviews
views = []
q_params = {'startdate' : date_parts['year'] + date_parts['month'] + date_parts['day'],
'enddate' : date_parts['year'] + date_parts['month'] + date_parts['day'],
'title' : '',
} #do this outside the loop?
for row in df_pandemic['page title']:
# print(dfd_test['event_pageTitle'])
# print(get_latest_rev(row))
#update the params with the current article title
q_params['title'] = row
v = get_pageviews(q_params)
views.append(v)
vs = pd.Series(views)
df_pandemic.insert(loc=3, column = 'views', value = vs)
df_pandemic.fillna(0, inplace=True) #turn the NaNs into zeros
df_pandemic['views'] = df_pandemic['views'].astype(int) #make values ints to remove the decimal
df_pandemic.sort_values('views', ascending=False, inplace=True)
rank = range(1, len(df_pandemic)+1)
df_pandemic['rank'] = list(rank)
rt_header = """== COVID-19 article status on {year}-{month}-{day} ==
Total articles: {articles}
Total pageviews (all articles): {views}
Last updated on ~~~~~
{{| class="wikitable sortable"
!Pageview rank
!Article
!Page views
!Predicted quality class
"""
footer = """|}
<!--IMPORTANT add all categories to the top section of the page, not here. Otherwise, they will get removed when the bot runs tomorrow! -->
"""
rt_row = """|-
|{view rank}
|[[{title}|{title}]]
|{views}
|{prediction}
"""
report_rows = [format_row(x, y, z, a, rt_row)
for x, y, z, a
in zip(df_pandemic['rank'],
df_pandemic['page title'],
df_pandemic['views'],
df_pandemic['quality prediction'],
)]
rows_wiki = ''.join(report_rows)
total_views = get_total_pageviews(df_pandemic, 'views')
total_articles = len(df_pandemic)
date_parts.update(views = total_views) #add in total views for all articles
date_parts.update(articles = total_articles) #add in total articles counted
header = rt_header.format(**date_parts)
output = header + rows_wiki + footer
edit_token = get_token(auth1)
edit_sum = "COVID-19 article report for {year}-{month}-{day}".format(**date_parts)
publish_report(output, edit_sum, auth1, edit_token)