wikimedia / mediawiki-api-demos

Demo apps and code snippets in Python, Javascript and PHP demonstrating how to use various modules of the MediaWiki Action API

MediaWiki API Demos

The MediaWiki Action API is a web service that allows access to some wiki-features like authentication, page operations, and search. It can provide meta information about the wiki and the logged-in user. This repository contains code snippets and demo apps in various programming languages to assist developers for easy use of various modules of the API.

ℹ️ View a showcase of interactive demo apps built using the API on Wikimedia Toolforge: https://tools.wmflabs.org/apps-gallery/

Code snippets

• Python
• Javascript
• PHP
• MediaWikiJS

Demo apps

• Holidays viewer: Demo app that fetches the holidays for a given date from Wikipedia, with an option to login to add new holidays. The app uses API:Parse to fetch the holidays and API:Edit to add a new holiday.
• Nearby places viewer: Demo of geo search for wiki pages near a location using the Geolocation API and MediaWiki Action API's Geosearch module.
• Picture of the day viewer: Demo app that uses prop=images module to fetch Wikipedia's Picture of the Day (POTD) from a template page and displays it on a webpage. The app also allows users to go backward or forward a date to view other POTD.
• User contributions feed: Demo app that uses list=usercontribs module to fetch the top 50 edits made by a user.
• View more demo apps

Installation

$ git clone https://github.com/wikimedia/mediawiki-api-demos.git
$ cd mediawiki-api-demos

For running python code samples: 
$ cd python
$ python3 filename.py 
Note: Install any necessary python modules with pip and enter any credentials 
required in the file to run the sample code

For running javascript code samples:
$ cd javascript
$ node filename.js
Note: Install any necessary node modules with npm and enter any credentials required
in the file to run the sample code

For running php code samples:
$ cd php
$ php filename.php
Note: Install necessary modules by `apt-get install php-cli php-curl` and enter any credentials
required in the file to run the sample code

mediawiki-api-demos's Issues

A.sai.com

https://hg.mozilla.org/projects/nss/rss-log

uBlock₀ — Asset viewer

plowe-0

Implement "API:Get the contents of a page" in Python

Hi! I'm learning to use Wiki API to get the public information of users. I found the script, "get_users.py", in MediaWiki-API-demos that can help us get general information, like edit count or email address. However, the personal description on the user page can not be fetched in this way.

(An example is shown below. I want to get the text information like "I'm not usually active on English Wikipedia. Please refer ...")

I found that "API: Get the contents of a page" offers an option to achieve that. Because I know nothing about PHP, may I ask is there any way we can get these text contents using the API in Python?

Thank you a lot for your time in advance!

Tassanee14

https://github.com/Tassanee-Ponlakarn/legendary-lamp/actions/runs/7377453764/job/20071441845#step:4:1

Public Key Server -- Get "0x069c04d206a59505 "

https://pgp.mit.edu/pks/lookup?op=get&search=0x069C04D206A59505

Wrong github url for user-contributions-app on the gallery

Problem
On the apps gallery, clicking on the "view on github" button of the User Contributions app sends you instead to article-ideas-generator app.

Expected behavior
It is supposed to open up a tab to user-contributions-app

SSL connection issue

Hi,

I had installed your python code and found it worked on wikipedia. I tried to connect my private wiki and found ssl issues.

After lots of try and error, suddenly I found the code succeed to make new wiki document. But it is not repeated.

Would you kindly advice me what to check to avoid ssl iissues?

Thanks in advance.

Add Travis integration

Add .travis.yml to run Python, PHP and Javascript linters.

planet.gnu.org/rss20.xml

https://planet.gnu.org/rss20.xml

Write sample code to demonstrate importing a page from another wiki via xml dump

Currently, we are missing the PHP and MediaWikiJS version here: https://www.mediawiki.org/wiki/API:Import/Sample_code_2

blog.diigo.com/feed/

https://blog.diigo.com/feed/

Extending the "Nearby Places Viewer" with street address using GeoPi

Hi @srish ,
I was wondering if I can extend the "Nearby Places Viewer" by adding a street address to the form and
using GeoPi to produce the latitude and longitude? Please let me know if this is something that you will accept a contribution from. I have a deadline to meet to submit contributions with Outreachy as well as Udacity. Thank you for your attention.

Add sample code for API: Options module

Reorganize README.md

Currently, README.md contain links to all Python files that live inside the Python directory. But, this repository is not just about Python files anymore and also include Javascript files. There might be PHP files too in the future.

Some ideas for improvements:

• There could be a logo of MediaWiki on the top in the README.
• All Python files could be linked from a README that lives in the Python directory.
• All Javascript files could be linked from a README that lives in the Javascript directory.
• If there is some magic way to reduce the number of lines in the current README that would be great.
• The main README can then only have an overview of the modules or demo apps that are in the repo.
• Also, installation and contributing code samples section can be removed as they will be taken care of here: #107.

Integrate more demo apps and make design improvements to the Apps gallery

Integrate demo apps with the Gallery

There are a lot of interesting demo apps using the MediaWiki API that meet the criteria listed here and could be added to the Apps Gallery: https://tools.wmflabs.org/apps-gallery/. Apps (some shared by @brendajerop), that we could add to the Gallery are listed below:

• QR code generator
• Holidays viewer
• Drive to Commons https://github.com/tonythomas01/gdrive_to_commons (not finished yet)
• Wikiquotes api https://github.com/natetyler/wikiquotes-api
• Wiki search: https://github.com/smallbrownbike/wikisearch
• Top: https://github.com/hatnote/top
• Trending: https://trending.wmflabs.org/ (hosted on toolforge, but can’t find code :/)
• Wikipedia viewer: https://github.com/sunilsj99/WikipediaViewer
• My move app: https://github.com/JanineLourens/neen_myMoveApp (uses MediaWiki API among others)
• Sightseer map: https://github.com/desinas/sightseer-map (uses MediaWiki API among others)
• Speed­Patrolling: https://github.com/lucaswerkmeister/tool-speedpatrolling
• https://pythonhosted.org/mwoauth/
• https://pythonhosted.org/mwapi/
• https://github.com/valerio-bozzolan/boz-mw
• https://github.com/fastily/jwiki
• https://github.com/brianckeegan/Wikipedia-Network-Analysis
• React native login app https://discuss-space.wmflabs.org/t/reactnative-login-app-with-mediawiki-api-for-beginner-mediawiki-developer/719
• Apps hosted on Toolforge. There might be some interesting ones here: https://tools.wmflabs.org/hay/directory/#/search/api
• Some tools that author Magnue Manske developed: https://tools.wmflabs.org/hay/directory/?search=Magnus#/author/Magnus%20Manske
• Some demo apps from the list: https://tools.wmflabs.org/hay/directory/?search=demo-apps#/search/demo.

Design improvements to the Gallery

Apps gallery could be made more responsive, adhered to the Wikimedia style guide https://design.wikimedia.org/style-guide/ and less bright perhaps ;-) It appears as shown below on lower resolutions:

Write sample code in Python, PHP and Javascript for merging page histories/revisions of Oldpage into Newpage with/without timestamp

These sample codes are for the API documentation https://www.mediawiki.org/wiki/API:Mergehistory

response.json() produces JSONDecodeError error since content is in invalid format

mediawiki-api-demos/apps/client-login/clientlogin.py

Line 53 in 9a5ac61

data = response.json()

Bug

When trying to work with the clientlogin method and using the default example from the documentation the user may encounter an issue where the response.json() produces json encoding error in the runtime. For example a common error would be:

simplejson.errors.JSONDecodeError: Expecting value: line 1 column 1 (char 0)

Expected behavior

Received the response that is documented in the docs:

{  
   "clientlogin":{  
      "status":"PASS",
      "username":"William"
   }
}

Workaround

I'd suggest parsing the response using:

data = json.loads(response.content)

instead of:

data = response.json()

Refactor `create_account_with_captcha.py` code

There are some leftover issues from #100 (review) that need to be addressed (that pull request was accidentally merged by @srish and couldn't be reverted back easily).

Add unit tests for API Endpoints.

Make improvements to user contributions demo app

Some suggestions I made to improve the UserContributions demo app in #89.

Suggested changes are here in this comment:
#89 (review).

__

https://github.com/avdaredevil

Link to mediawikijs code samples from mediawikijs/README.md

mediawikijs/README.md should contain links to all the mediawikijs code samples available.

Develop a bot that mass edits sample code in this repo to API namespace on MediaWiki.org and vice-versa

The bot script can be made to run automatically or manually. In either case, the bot should be able to detect any new changes made in the "Javascript", "PHP", "Python" and "MediawikiJS" folder since its previous version either in this repository or in the API namespace on MediaWiki.org. If any new changes are detected, then the corresponding API module pages should receive updates. Also, figure out an appropriate way to sync the changes made to the module pages on MediaWiki.org with this repository. One vague idea - every change made to a page could open a pull request in this repo.

This would require a change in the modules.json structure, probably an addition of a new parameter in every module item (e.g., filename) that stores its page name on MediaWiki.org. A few additional changes required in all the sample code files:

• Document this repository's URL in all files.
• Remove the line that says: "This file is auto-generated..."

Contributing page has broken link to info sending Pull Requests

https://github.com/wikimedia/mediawiki-api-demos/blob/master/gallery/contributing.md says "see more instructions on sending a pull request here."

• The anchor in the URL does not exist.
• https://www.w3.org/QA/Tips/noClickHere

Add sample code for API:filearchive in Python, PHP and JavaScript

Write sample code in MediaWikiJS to demonstrate logging in/out to/from a wiki

API reference: https://doc.wikimedia.org/mediawiki-core/master/js/#!/api/mw.Api.plugin.login
Sample code to be added here: https://www.mediawiki.org/wiki/API:Login/Sample_code_1
https://www.mediawiki.org/wiki/API:Logout/Sample_code_1

w3.org/events/feed/

https://www.w3.org/events/feed/

Add sample code for API:RecentChanges

seeking to add sample code for API:RecentChanges

Write sample code in PHP and MediaWikiJS for uploading a local file directly and in chunks

We are missing sample code in PHP & MediaWikiJS for two scenarios: uploading a local file directly and and in chunks:
https://www.mediawiki.org/wiki/API:Upload
https://www.mediawiki.org/wiki/API:Upload#Sample_code_3

A tool to search Wiki articles by your location

• Wikiaround:
  Uses geo search for wiki articles, user's location and Google maps to display. Based on MediaWiki Action API's Geosearch module.

Autogenerate python files for MediaWiki Action API GET Requests demos where feasible

For supporting code samples in languages other than Python, and making code contribution to these examples quick and easy, it might be useful to be able to auto-generate the API GET Requests demos where feasible probably via a JSON schema.

Rewrite API:Deletedrevs

Deletedrevs should remove from the modules.json because to make such request we have to give the login user session. So we have to write this module again.

Apps Gallery: "View on GitHub" does not go to GitHub for numerous tools

1. Go to https://apps-gallery.toolforge.org/
2. Click "View on GitHub" links for numerous tools

• OAuth Hello World: "View on GitHub" does not link to GitHub but to https://tools.wmflabs.org/oauth-hello-world/index.php?action=download
• MassMailer: "View on GitHub" does not link to GitHub but to https://phabricator.wikimedia.org/source/tool-massmailer/
• Search Starter: "View on GitHub" does not link to GitHub but to https://glitch.com/edit/#!/wikipedia-search-starter

Add sample code for send an email to demonstrate the use of API:Emailuser module

An email can be sent to users who have a confirmed email address. The API:Emailuser module page hasn't a code sample to demonstrate this action.It is good to develop code sample for this.

The link of action API:Emailuser module is : https://www.mediawiki.org/wiki/API:Emailuser

Apps Gallery: "Try it out" link for "Wiki Login" tool broken

1. Go to https://apps-gallery.toolforge.org/
2. Look at "Wiki Login"

"Try it out" links to http://tools.wmflabs.org/ which redirects to https://wikitech.wikimedia.org/wiki/Portal:Toolforge so it does not work?

Action API action=logout will require a CSRF token

With the merge of Icb674095,[1] use of API action=logout will require a
CSRF token. This was considered a security issue, so the usual deprecation
process was not followed. See T25227[2] for details.

[1] https://gerrit.wikimedia.org/r/c/mediawiki/core/+/504565
[2] https://phabricator.wikimedia.org/T25227

See full context at https://lists.wikimedia.org/pipermail/mediawiki-api-announce/2019-April/000145.html

Wikimedia Image upload via API - help needed for mapcomplete

Hi,
the Mapcomplete dev Peter is asking for help with uploading images to Wikimedia Commons via the Wikimedia API.
Mapcomplete is an awesome tool to build maps with OSM data.
If someone could help Peter (or you know someone who potentially could) , it would be great
pietervdvn/MapComplete#99

Thanks a lot.

How to use Signature or User ID to get user's information?

Hi there,

I'm a beginner at Wikimedia, and I'm using Wiki API to finish my project. My dataset looks like this:

rev_id | comment | timestamp | page_id | page_title | user_id | user_text
-- -- -- -- -- -- -- -- -- -- -- --
352194497 | Welcome   to Wikipedia | 2010-03-26T18:16:48Z | 26709696 | 116.197.206.138 | 8356162 | Mlpearc

I'm trying to find some user information of these comment posters. However, I find the "user_text" here is not the user name but the signature. If I use the official API demos get_users.py to get the information, it turns out the error because some signature have space in it, but usernames are all single word. Like in the code below, I can get the information of Catrope and Bob using Catrope|Bob. But it doesn't work if I use Catrope|Bob Ben, if Bob Ben is Bob's signature.

import requests

S = requests.Session()

URL = "https://en.wikipedia.org/w/api.php"

PARAMS = {
    "action": "query",
    "format": "json",
    "list": "users",
    "ususers": "Catrope|Bob",
    "usprop": "blockinfo|groups|editcount|registration|emailable|gender"
}

R = S.get(url=URL, params=PARAMS)
DATA = R.json()

USERS = DATA["query"]["users"]

for u in USERS:
    print(str(u["name"]) + " has " + str(u["editcount"]) + " edits.")

So my question is, is there any way we can get user information through the signature using API? And since we also have page_id and user_id here, will this information be helpful? Thank you so much in advance!

Add an example to demonstrate the use of API:Links module to identify red links on a page

More in response to the question asked here: https://discourse-mediawiki.wmflabs.org/t/data-returned-by-the-query-api-does-not-say-if-a-link-is-a-red-link-or-not/1043.

It would be a cool use case of how API:Links module can also be used as a generator.

filename not generic in modules.json

Currently, in the modules.json file the filename key has .py extension in all instances. But when generating code for javascript and php the filenames extension should be .js and .php respectievly. So, it should be made generic so that it can be used with any of them.
I would like to take up this issue

[email protected]

mailto:[email protected]

feeds.feedburner.com/WipmaniaBlogPostsen

https://feeds.feedburner.com/WipmaniaBlogPostsen

Add sample code for blocking user to demonstrate the use of API:Block module

The link of action API:Block module is : https://www.mediawiki.org/wiki/API:Block
This page hasn't a code sample to demonstrate the use of API:Block.It is good to develop code sample for this.

Write sample code in MediaWiki JS to get a user's watchlist feed

To be documented here: https://www.mediawiki.org/wiki/API:Watchlist_feed

Nearby places viewer. 500 Internal Server error

I tried playing with this thing https://nearby-places-viewer.toolforge.org/nearby-places-viewer/ (found via https://www.mediawiki.org/wiki/API:Nearby_places_viewer )

But it's posting to the same URL and getting back a 500 Internal Server error

I don't know if it's an issue with in the code, or just something need fixing on the server. What does the error log say?

Create code samples demonstrating account creation on the wiki via API for different cases

The account creation via the API is a complex process. It works differently in different cases: when creating an account for someone else, on a wiki with or without special authentication extensions installed. It might be good to develop code samples for different use cases and embed them here: https://www.mediawiki.org/wiki/API:Account_creation. Three use cases to develop code samples for:

• A simple example, the case of a wiki where there aren't any special authentication extensions installed
• Complex example, the case of a wiki with special authentication extensions installed
• On a wiki with captcha enabled (Extension:ConfirmEdit)
• On a wiki with two factor authentication enabled (Extension:OpenID or OATHAuth)

Update README.md

Update README.md to include instructions for how to resolve a merge conflict in a pull request

Apps Gallery: Clarify that some tools only query English (!) Wikipedia

1. Go to https://apps-gallery.toolforge.org/
2. Look at "Search Starter": "Searches wikipedia and displays the first search result"
3. Look at "Wikipedia Viewer": "Allows searching on Wikipedia"

Both seem to be only about English (!) Wikipedia but there are about 300 other Wikipedias. This should be made clear.

"Account Creator" down and source 404

1. https://developer.wikimedia.org/ first link: https://developer.wikimedia.org/use-content/ first link: https://developer.wikimedia.org/use-content/featured-apps/ first link: https://apps-gallery.toolforge.org/
2. "Account Creator"
3. "Try it out": https://tools.wmflabs.org/account-creator/
   • 502 Bad Gateway (after a redirect to https://account-creator.toolforge.org/)
4. "View on GitHub": https://github.com/wikimedia/mediawiki-api-demos/tree/master/apps/create-account-with-captcha
   • 404 Not Found

Looks like the latter is now at https://github.com/wikimedia/mediawiki-api-demos/tree/master/apps/account-creator.

Ai