Merge pull request #5 from AYLIEN/add-wiki-current-events-portal-source

Adding WikimediaSignal and tools for searching Wikipedia Currents Events portal

README.md

@@ -11,6 +11,7 @@ These notebooks let you try out `news-signals` without installing anything!
 
 The Colab notebooks above are also available as jupyter notebooks in [research/news-signals-example-notebooks](research/news-signals-example-notebooks)
 
+**2023-11-30: NEW**: [Create_Wikimedia_Signals.ipynb](research/news-signals-example-notebooks/Create_Wikimedia_Signals.ipynb) shows how to build and explore a `WikimediaSignal` which does not a NewsAPI account and works out-of-the-box for anyone.
 
 ## Quickstart
 

VERSION

@@ -1 +1 @@
-0.3.1
+0.4.0

news_signals/dataset_transformations.py

@@ -61,10 +61,31 @@ def transform(signal):
     return dataset
 
 
+def add_wikipedia_current_events(
+    dataset,
+    wikidata_client=None,
+    wikipedia_endpoint=None,
+    overwrite_existing=False
+):  
+    def transform(signal):
+        return signal.add_wikipedia_current_events(
+            wikidata_client=wikidata_client,
+            wikipedia_endpoint=wikipedia_endpoint,
+            overwrite_existing=overwrite_existing
+        )
+    try:
+        dataset.map(transform)
+    except WikidataIDNotFound as e:
+        logger.error(f"Could not find Wikidata ID for signal: {e}, did not apply the pageviews transformation.")
+    return dataset
+
+
+
 REGISTRY = {
     "add_anomalies": add_anomalies,
     "add_summaries": add_summaries,
-    "add_wikimedia_pageviews": add_wikimedia_pageviews
+    "add_wikimedia_pageviews": add_wikimedia_pageviews,
+    "add_wikipedia_current_events": add_wikimedia_pageviews
 }