fika_analyzer.py

#! /usr/bin/env python3

import logging
from datetime import date

import requests

ACTION_API_URL = "https://sv.wikipedia.org/w/api.php"


def get_pageviews(
        project,
        page,
        start_date,
        end_date,
        access="all-access",
        agent="user",
        granularity="daily"
):
    """Get the pageviews for a page."""

    response = send_pageview_request(
        project=project,
        page=page,
        start_date=start_date,
        end_date=end_date,
        access=access,
        agent=agent,
        granularity=granularity
    )
    pageviews = 0
    for item in response["items"]:
        pageviews += item["views"]
    logging.info("Total pageviews: {}.".format(pageviews))
    return pageviews


def send_pageview_request(
        project,
        access,
        agent,
        page,
        granularity,
        start_date,
        end_date
):
    """Send request for pageviews to the API.

    Returns the JSON response for the request, as a dictionary.
    """

    api_base_url = "https://wikimedia.org/api/rest_v1"
    pageview_path = "metrics/pageviews/per-article"
    url = "{base}/{pageview}/{project}/{access}/{agent}/{article}/" \
          "{granularity}/{start}/{end}".format(
              base=api_base_url,
              pageview=pageview_path,
              project=project,
              access=access,
              agent=agent,
              article=page.replace("/", "%2F"),
              granularity=granularity,
              start=start_date,
              end=end_date
          )
    request = requests.get(url)
    response = request.json()
    logging.debug("Response: {}".format(response))
    return response


def get_number_of_questions():
    """Get the number of questions from the questions page.

    The number of sections are used to count questions.
    """

    response = send_sections_request(
        ACTION_API_URL,
        "Wikipedia:Fikarummet/Frågor"
    )
    sections = response["parse"]["sections"]
    number_of_questions = 0
    for section in sections:
        if int(section["level"]) == 2:
            # Each question creates a section of level 2.
            number_of_questions += 1
    return number_of_questions


def send_sections_request(api_url, page):
    """Send a request to the action API, asking for the sections of a page.

    Returns the JSON response for the request, as a dictionary.
    """

    response = requests.get(
        url=api_url,
        params={
            "action": "parse",
            "format": "json",
            "page": page,
            "prop": "sections"
        }
    ).json()
    logging.debug("Response: {}".format(response))
    return response


def get_number_of_invitees():
    """Get the number of users invited to Fikarummet.

    The number of invitees is retrieved from a category, that each
    user gets when they receive the invitation.
    """

    response = send_category_request(
        ACTION_API_URL,
        "Kategori:Wikipedianer som har fått en inbjudan till fikarummet"
    )
    pages = response["query"]["pages"]
    category_id = list(pages.keys())[0]
    number_of_invitees = pages[category_id]["categoryinfo"]["pages"]
    return number_of_invitees


def send_category_request(api_url, category):
    """Send a request to the action API, asking for info for a category.

    Returns the JSON response for the request, as a dictionary.
    """
    response = requests.get(
        url=api_url,
        params={
            "action": "query",
            "format": "json",
            "prop": "categoryinfo",
            "titles": category
        }
    ).json()
    logging.debug("Response: {}".format(response))
    return response


if __name__ == "__main__":
    logging.basicConfig(
        format="%(asctime)s - %(levelname)s - %(message)s",
        level=logging.DEBUG
    )
    # Run with some default values for Fikarummet.
    pageviews = get_pageviews(
        "sv.wikipedia.org",
        "Wikipedia:Fikarummet",
        "20161209",
        date.today().strftime("%Y%m%d")
    )
    print("Pageviews for Fikarummet: {}".format(pageviews))
    pageviews = get_pageviews(
        "sv.wikipedia.org",
        "Wikipedia:Fikarummet/Frågor",
        "20161209",
        date.today().strftime("%Y%m%d")
    )
    print("Pageviews for Fikarummet/Frågor: {}".format(pageviews))
    print("Number of questions: {}".format(get_number_of_questions()))
    print("Number of invitees: {}".format(get_number_of_invitees()))