Free Software Directory:Pywikibot

Free Software Directory:Participate/Using pywikibot should be merged to this page.

MediaWiki

• Add this to LocalSettings.php

# Allow batch uploading for pywikibot
$wgGrantPermissions['editpage']['approverevisions'] = true; # Required by the MediaWiki Extension "Approved Revs" to create new pages
$wgGrantPermissions['editprotected']['editarticles'] = true;
$wgFileExtensions[] = 'wiki';

Generate a bot account for your user

The bot will be associated with the user name that are logged in.

• Login as WikiSysop in http://directory.fsf.org/
• Visit http://directory.fsf.org/wiki/Special:BotPasswords and generate a new bot.
  • Bot name: wikibot
  • Store the generated password somewhere

Background to using the bot

The method of using BotPasswords improves the security overall. However bot's are required due to a CASAuth issue:

See also the CASAuth issue on this page.

pywikibot

# The --recursive option (or "git submodule update --init" after git clone) is required to get scripts/pagefromfile.py working
git clone --recursive https://gerrit.wikimedia.org/r/pywikibot/core pywikibot-core
cd pywikibot-core
python generate_family_file.py 'http://directory.fsf.org/wiki/Main_Page' 'freesoftwaredirectorydev'
python pwb.py generate_user_files
# Select family of sites we are working on, just enter the number or name (default: wikipedia): freesoftwaredirectorydev
# The only known language: en
# The language code of the site we're working on (default: en): 
# Username on en:freesoftwaredirectorydev: WikiSysop
# Do you want to add any other projects? ([y]es, [N]o): n
# Do you want to add a BotPassword for WikiSysop? ([y]es, [N]o, [q]uit): y
# See https://www.mediawiki.org/wiki/Manual:Pywikibot/BotPasswords to
# know how to get codes.Please note that plain text in /home/root
# /pywikibot-core/user-password.py and anyone with read access to that
# directory will be able read the file.
# BotPassword's "bot name" for WikiSysop: wikibot
# BotPassword's "password" for "WikiSysop" (no characters will be shown): 
# '/home/root/pywikibot-core/user-config.py' written.

Test pywikibot on MediaWiki

python pwb.py upload -always -ignorewarn ~/heckert_gnu.transp.small.png "Some description"

Estimate time for batch uploading

script_generated=$(date +"%Y-%m-%d %H:%M:%S.%N"); # .wiki files with identical content since the last revision will be ignored ("No changes were needed on [[YOURTITLE]]")
SECONDS=0

for (( i=0; i<10; i++ )); do
  echo "$script_generated" > Test.wiki;
  python pwb.py pagefromfile -summary:"The edit summary" -title:"Test$i" -file:"Test.wiki" -textonly -force -pt:0
done
duration=$SECONDS
echo "$(($duration / 10)) seconds per entry in average."
rm -f Test.wiki

Issues

CASAuth

This issue doesn't have to be fixed since there's a work around, but it would be great if it were fixed to give us more options.

zhuyifei1999:

Pywikibot [1] is a MediaWiki bot library which we are attemting to utilize to perform batch uploads. However, because of CASAuth, we are unable [2] to perform main account CAS-based login, and have to resort to using BotPasswords. However, to upload, permissions to alter "File" namespace is needed, but it is restricted to the 'editarticles' permission [4], and there is no grant [5] that gives the permission to any BotPasswords-based login. Please add 'editarticles' to the 'Edit protected pages' set [5], or any other set if you deem appropriate, to allow batch uploading.

1. https://www.mediawiki.org/wiki/Manual:Pywikibot
2. https://github.com/CWRUChielLab/CASAuth/issues/7
3. https://www.mediawiki.org/wiki/Manual:Pywikibot/BotPasswords
4. https://directory.fsf.org/wiki/Special:ListGroupRights
5. https://directory.fsf.org/wiki/Special:ListGrants

// zhuyifei1999@gmail.com, zhuyifei1999_ in #pywikibot at irc.freenode.net, http://commons.wikimedia.org/wiki/User:Zhuyifei1999

Suggestions

OAuth

pywikibot can be used with OAuth - https://www.mediawiki.org/wiki/Manual:Pywikibot/OAuth. However, the OAuth extension is currently not installed - https://directory.fsf.org/wiki/Special:Version

Further reading

Read https://www.mediawiki.org/wiki/Manual:Importing_XML_dumps#Using_pywikibot,_pagefromfile.py_and_Nokogiri for more information