Install Python edit
Download and install Python from https://www.python.org/downloads/.
If you already have Python installed, check if your version is recent enough by running
python --version in a console.
To discover if Python version 3 or above is installed, run
python3 --version in a console.
Ubuntu 19.04 and up comes with versions 2 & 3 installed.
Python v2 runs by default using terminal command
python; to use v3, use terminal command
Python 3.6.1 or higher is currently required to run the bot, but Python 3.7 or higher is recommended. On Windows please do not forget to modify PATH environment variable to make Python and pip work properly.
Install dependencies edit
An additional package named requests is required to run Pywikibot. Use pip, which is included by default in all supported Python versions. Run the following command to install this package:
$ python -m pip install "requests>=2.20.1"
In addition a MediaWiki markup parser is required. Please install (at least) one of the following (or both):
$ python -m pip install "mwparserfromhell>=0.5.0"
$ python -m pip install "wikitextparser>=0.47.5"
Install Pywikibot edit
$ python -m pip install pywikibot
If using pip, use
pwb instead of
python pwb.py in examples below.
Unpack downloaded file, for example in
Alternatively, you may retrieve the latest version using git or svn client from Gerrit, see Manual:Pywikibot/Gerrit. This is the recommended way for active bot operators and developers to use Pywikibot.
Other versions are available at https://pywikibot.toolforge.org/.
Updating Pywikibot edit
Keep your bot framework up to date. New versions are released continuously, and are available at the same location.
If you are using git or svn release, you may skip this note. Otherwise please be aware of a necessity to backup your configuration files and scripts (user-config.py, any family file, or custom script that you might have created or changed, and any current XML dump file you're using for a wiki) before installing a new release.
Unpack the new version over the old version, overwriting all files.
Configure Pywikibot edit
Open Terminal on Unix-like (Linux/BSD/Solaris) or Command Prompt on Windows (typically under Windows System or Accessories folders in All apps or All programs menu inside the Start menu), and change directory to where you unpacked Pywikibot:
- Unix-like (Linux/BSD/Solaris):
$ cd ~/core
$ c: $ cd "\Users\username\pywikibot"
Substitute the location to where you unpacked Pywikibot.
Continue with the following command to generate user configuration file:
$ python pwb.py generate_user_files
Follow the prompts to configure Pywikibot.
Finally run the following command to log in to your wiki:
$ python pwb.py login
Use on third-party wikis edit
Pywikibot is pre-configured for a large number of wikis, but possibly not for the one you want to work on. See Manual:Pywikibot/Use on third-party wikis for how to configure Pywikibot for your wiki.
More configuration options edit
Pywikibot provides a wide range of configuration options to change the behavior of your bot. You can change these settings in the file user-config.py. See config.py for a list of all parameters you can use.
Proxy configuration edit
Pywikibot relies on
requests for communicating with the web.
You can use
HTTPS_PROXY environment variables to make requests use a proxy server.
Refer to requests' documentation for more info.
Run a script edit
Pywikibot comes packaged with a large number of scripts in the scripts directory. You can run all of these using:
$ python pwb.py [name of the script]
To learn more about running basic Pywikibot scripts, see:
- Small wiki toolkits workshop about running basic Pywikibot scripts
- Self-study materials based on the small wiki toolkits workshop
- Workshop handbook based on the small wiki toolkits workshop
Other dependencies edit
Most scripts do not require additional packages, but a few of them will not work without. These are listed in requirements.txt together with their dependencies.
To install dependencies for some script, use pip, and run the following command:
$ python -m pip install [name of the package]
Alternatively, run the following command to install all dependencies for all scripts at once:
$ python -m pip install -r requirements.txt