You are browsing a read-only backup copy of Wikitech. The live site can be found at wikitech.wikimedia.org
Help:Toolforge/Pywikibot
Jump to navigation
Jump to search
The Pywikibot framework is a Python library and collection of scripts to automate work on MediaWiki sites.
Installation and setup
- Become your tool-account
MAINTAINER@tools-sgebastion-10:~$ become TOOLNAME - Create a setup script (e.g.,
pwb_venv.sh) that creates a virtual environment and installs dependencies.You need to install from git if you want to use the Pywikibot scripts.tools.TOOLNAME@tools-sgebastion-10:~$ touch $HOME/pwb_venv.sh tools.TOOLNAME@tools-sgebastion-10:~$ chmod ug+x $HOME/pwb_venv.sh # make the script executable
| Pywikibot installation source | Example |
|---|---|
| PyPI | pwb_venv.sh #!/bin/bash
# clean-up directories if they already exist
rm -fdr pwbvenv
# create a virtual environment
python3 -m venv pwbvenv
# activate it
source pwbvenv/bin/activate
# install dependencies
pip install --upgrade pip setuptools wheel
pip install pywikibot[mwoauth,mysql] # update as needed
pip install ... # any other dependencies here
|
| git | pwb_venv.sh #!/bin/bash
# clean-up directories if they already exist
rm -fdr pwbvenv $HOME/pywikibot-core
# create a virtual environment
python3 -m venv pwbvenv
# activate it
source pwbvenv/bin/activate
# clone Pywikibot
git clone --recursive --branch stable "https://gerrit.wikimedia.org/r/pywikibot/core" $HOME/pywikibot-core
# install dependencies
pip install --upgrade pip setuptools wheel
pip install $HOME/pywikibot-core[mwoauth,mysql] # update as needed
pip install ... # any other dependencies here
|
- Run the setup script using the jobs framework.
tools.TOOLNAME@tools-sgebastion-10:~$ toolforge-jobs run setup-venv --command $HOME/pwb_venv.sh --image python3.9 --wait INFO: job 'setup-venv' completed
- Configure Pywikibot
- Interactively:user-config.py and (optionally) user-password.py are generated by following the prompts.
tools.TOOLNAME@tools-sgebastion-10:~$ webservice python3.9 shell # start an interactive Kubernetes shell tools.TOOLNAME@shell-#########:~$ source pwbvenv/bin/activate # activate the virtual environment (pwbvenv) tools.TOOLNAME@shell-#########:~$ pwb generate_user_files # run the generate_user_files.py Pywikibot script
- Manually: See the manual on MediaWiki wiki: user-config.py, BotPasswords, and OAuth.
- Interactively:
- You may test the installation from an interactive shell.
tools.TOOLNAME@tools-sgebastion-10:~$ webservice python3.9 shell # start an interactive Kubernetes shell tools.TOOLNAME@shell-#########:~$ source pwbvenv/bin/activate # activate the virtual environment (pwbvenv) tools.TOOLNAME@shell-#########:~$ pwb version # run the version.py Pywikibot script Pywikibot: pywikibot/__init__.py (, -1 (unknown), 2023/01/21, 21:32:22, UNKNOWN) Release version: 8.0.0 setuptools version: 66.1.1 mwparserfromhell version: 0.6.4 wikitextparser version: n/a requests version: 2.28.2 cacerts: /data/project/TOOLNAME/pwbvenv/lib/python3.9/site-packages/certifi/cacert.pem certificate test: ok Python: 3.9.2 (default, Feb 28 2021, 17:03:44) [GCC 10.2.1 20210110] PYWIKIBOT_DIR: Not set PYWIKIBOT_DIR_PWB: /data/project/TOOLNAME/pwbvenv/lib/python3.9/site-packages/pywikibot/scripts PYWIKIBOT_NO_USER_CONFIG: Not set Config base dir: /data/project/TOOLNAME Usernames for family 'commons': commons: Example bot
Create jobs
- Main article: Help:Toolforge/Jobs framework
Example of running the Pywikibot version.py script once:
tools.TOOLNAME@tools-sgebastion-10:~$ toolforge-jobs run pywikibot-version --command "$HOME/pwbvenv/bin/pwb version" --image python3.9
Example of running your own script on a schedule:
tools.TOOLNAME@tools-sgebastion-10:~$ toolforge-jobs run my-cool-job --command "$HOME/pwbvenv/bin/python3 $HOME/my-cool-script.py" --image python3.9 --schedule "1 2 * * 3"
Additional parameters for the job could include, for example, additional memory allocation (--mem MEM), job restart after being finished (--continuous), etc.
Communication and support
Support and administration of the WMCS resources is provided by the Wikimedia Foundation Cloud Services team and Wikimedia Movement volunteers. Please reach out with questions and join the conversation:
Discuss and receive general support
- Chat in real time in the IRC channel #wikimedia-cloud connect, the bridged Telegram group, or the bridged Mattermost channel
- Discuss via email after you subscribed to the cloud@ mailing list
Receive mail announcements about critical changes
Subscribe to the cloud-announce@ mailing list (all messages are also mirrored to the cloud@ list)
Track work tasks and report bugs
Use a subproject of the #Cloud-Services Phabricator project to track confirmed bug reports and feature requests about the Cloud Services infrastructure itself
Learn about major near-term plans
Read the News wiki page
Read news and stories about Wikimedia Cloud Services
Read the Cloud Services Blog (for the broader Wikimedia movement, see the Wikimedia Technical Blog)