38fdd07b39
- Renamed the articles.txt to something more specific Changes to both scripts: - Updated filenames to match the new standard - Reworked the logging code so that it can write to stderr by default. Because we can only call logging.basicConfig() once, this eneded up being a bigger changes. - Caused scripts to output git commits and export to track which code produced which dataset. - Caused programs to take files instead of directories as output (allows us to run programs more than once a day). Changes to the wikipedia_views/scripts/fetch_daily_views.py: - Change output that it outputs a sequence of JSON dictionaries (one per line) as per the standard we agreed to and which is what Twitter, Github, and other dumps do. Previous behavior was to create output a single JSON list object. - A number of other small changes and tweaks throughout.
129 lines
4.6 KiB
Python
Executable File
129 lines
4.6 KiB
Python
Executable File
#!/usr/bin/env python3
|
|
|
|
###############################################################################
|
|
#
|
|
# This script assumes the presence of the COVID-19 repo.
|
|
#
|
|
# It (1) reads in the article list and then (2) calls the Wikimedia API to
|
|
# fetch view information for each article. Output is to (3) JSON and TSV.
|
|
#
|
|
###############################################################################
|
|
|
|
import sys
|
|
import subprocess
|
|
import requests
|
|
import argparse
|
|
import json
|
|
import time
|
|
import os.path
|
|
import argparse
|
|
import datetime
|
|
import logging
|
|
from csv import DictWriter
|
|
#import feather #TBD
|
|
|
|
def parse_args():
|
|
|
|
parser = argparse.ArgumentParser(description='Call the views API to collect data view data.')
|
|
parser.add_argument('-o', '--output_folder', help='Where to save output', default="wikipedia_views/data", type=str)
|
|
parser.add_argument('-i', '--article_file', help='File listing article names', default="wikipedia_views/resources/enwp_wikiproject_covid19_articles.txt", type=str)
|
|
parser.add_argument('-d', '--query_date', help='Date if not yesterday, in YYYYMMDD format.', type=str)
|
|
parser.add_argument('-L', '--logging_level', help='Logging level. Options are debug, info, warning, error, critical. Default: info.', default='info', type=str),
|
|
parser.add_argument('-W', '--logging_destination', help='Logging destination file. (default: standard error)', type=str),
|
|
args = parser.parse_args()
|
|
return(args)
|
|
|
|
def main():
|
|
|
|
args = parse_args()
|
|
|
|
outputPath = args.output_folder
|
|
articleFile = args.article_file
|
|
|
|
#handle -d
|
|
if args.query_date:
|
|
queryDate = args.query_date
|
|
else:
|
|
yesterday = datetime.datetime.today() - datetime.timedelta(days=1)
|
|
queryDate = yesterday.strftime("%Y%m%d")
|
|
|
|
queryDate = queryDate + "00" #requires specifying hours
|
|
|
|
#handle -L
|
|
loglevel_mapping = { 'debug' : logging.DEBUG,
|
|
'info' : logging.INFO,
|
|
'warning' : logging.WARNING,
|
|
'error' : logging.ERROR,
|
|
'critical' : logging.CRITICAL }
|
|
|
|
if args.logging_level in loglevel_mapping:
|
|
loglevel = loglevel_mapping[args.logging_level]
|
|
else:
|
|
print("Choose a valid log level: debug, info, warning, error, or critical")
|
|
exit
|
|
|
|
#handle -W
|
|
if args.logging_destination:
|
|
logging.basicConfig(filename=args.logging_destination, filemode='a', level=loglevel)
|
|
else:
|
|
logging.basicConfig(level=loglevel)
|
|
|
|
export_git_hash = subprocess.check_output(['git', 'rev-parse', 'HEAD']).decode().strip()
|
|
export_git_short_hash = subprocess.check_output(['git', 'rev-parse', '--short', 'HEAD']).decode().strip()
|
|
export_time = str(datetime.datetime.now())
|
|
|
|
logging.info(f"Starting run at {export_time}")
|
|
logging.info(f"Last commit: {export_git_hash}")
|
|
|
|
#1 Load up the list of article names
|
|
j_outfilename = os.path.join(outputPath, f"digobs_covid19-wikipedia-enwiki_dailyviews-{queryDate}.json")
|
|
t_outfilename = os.path.join(outputPath, f"digobs_covid19-wikipedia-enwiki_dailyviews-{queryDate}.tsv")
|
|
|
|
with open(articleFile, 'r') as infile:
|
|
articleList = list(infile)
|
|
|
|
success = 0 #for logging how many work/fail
|
|
failure = 0
|
|
|
|
#3 Save results as a JSON and TSV
|
|
with open(j_outfilename, 'w') as j_outfile, \
|
|
open(t_outfilename, 'w') as t_outfile:
|
|
|
|
#2 Repeatedly call the API with that list of names
|
|
for a in articleList:
|
|
a = a.strip("\"\n") #destringify
|
|
url= f"https://wikimedia.org/api/rest_v1/metrics/pageviews/per-article/en.wikipedia/all-access/all-agents/{a}/daily/{queryDate}/{queryDate}"
|
|
|
|
response = requests.get(url)
|
|
if response.ok:
|
|
jd = response.json()["items"][0]
|
|
success = success + 1
|
|
else:
|
|
failure = failure + 1
|
|
logging.warning(f"Failure: {response.status_code} from {url}")
|
|
|
|
# start writing the CSV File if it doesn't exist yet
|
|
try:
|
|
dw
|
|
except NameError:
|
|
dw = DictWriter(t_outfile, sorted(jd.keys()), delimiter='\t')
|
|
dw.writeheader()
|
|
|
|
logging.debug(f"printing data: {jd}")
|
|
|
|
# write out the line of the json file
|
|
print(json.dumps(jd), file=j_outfile)
|
|
|
|
# write out of the csv file
|
|
dw.writerow(jd)
|
|
|
|
# f_Out = outputPath + "dailyviews" + queryDate + ".feather"
|
|
# read the json back in and make a feather file?
|
|
logging.debug(f"Run complete at {datetime.datetime.now()}")
|
|
logging.info(f"Processed {success} successful URLs and {failure} failures.")
|
|
|
|
|
|
if __name__ == "__main__":
|
|
|
|
main()
|