Manual:Pywikibot/Installation

 This page will help you get started with Pywikibot, either on your own computer, on Toolforge, or using PAWS: A Web Shell.

  On paws>wikitech:PAWS|PAWS

PAWS: A Web Shell is the easiest way to get started with Pywikibot.

No installation is necessary, and you use a web interface to submit commands.

 On your own computer

Below is a manual to help you set Pywikibot up and running on your own computer. There are four main steps to this process:  On toolforge>wikitech:Help:Toolforge|Toolforge
 * Installing Python
 * Installing Pywikibot
 * Configuring Pywikibot
 * Running a script

Toolforge provides you with a stable cloud infrastructure on Wikimedia servers that allows you to run bots continuously or on a schedule.

Install Python
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  in a console.

If you have Python 2.7.4 or higher, or Python 3.4 or higher installed, your version of Python is recent enough.

However, Python versions below 3.5 can be dropped in near future.

It is strictly recommended to use Python 3.5 or higher.

Modify the path
On Windows systems, even after installing python, the command line interface may not initially know where the python installation is located (although the installer has an option to make it know). In other words, if you enter the command

C:\Users\Joe>python

it may result in the following error:

'python' is not recognized as an internal or external command, operable program or batch file.

To fix this, you need to modify the environment variable named "path" and add the folder which contains "python.exe". On Windows 10, this is under Settings > System > About > System info > Advanced System Settings > Environment Variables. Closing and re-opening the command line, entering "python" should give some information about your current python installation. This same process can be repeated for pip. If you enter the command

C:\Users\Joe>pip

and it displays an error, also add the folder containing "pip.exe" to the path.

Install dependencies
An additional package named requests is required to run Pywikibot. Use pip, which is already installed if you have Python 2.7.9</> or higher, or Python <tvar|py3>3.4</> or higher. Run the following command to install this package:

Install Pywikibot
Download current Pywikibot <tvar|ver>stable branch</>: <tvar|tgz>.tar.gz</>, <tvar|zip>.zip</>.

Unpack downloaded file, for example in <tvar|1> </> or.

Alternatively, you may retrieve the latest version using git or svn client from Gerrit, see <tvar|gerrit></>. This is the recommended way for active bot operators and developers to use Pywikibot.

Other versions are available at <tvar|old>https://tools.wmflabs.org/pywikibot/</>.

Updating Pywikibot
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 (<tvar|userconfig>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
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):




 * Windows:



Of course substitute the location to where you unpacked Pywikibot.

Continue with the following command to generate user configuration file:

Follow the prompts to configure Pywikibot.

Finally run the following command to log in to your wiki:

Use on third-party wikis
Pywikibot is pre-configured for a large number of wikis, but possibly not for the one you want to work on.

See <tvar|thirdparty></> for how to configure Pywikibot for your wiki.

More configuration options
Pywikibot provides a wide range of configuration options to change the behavior of your bot.

You can change these settings in the file <tvar|userconfig>user-config.py</>.

See <tvar|config2>config2.py</> for a list of all parameters you can use.

Run a script
Pywikibot comes packaged with a large number of scripts in the scripts directory.

You can run all of these using:

A list of all scripts is available at <tvar|scripts></>.

Other dependencies
Most scripts do not require additional packages, but a few of them will not work without.

These are listed in <tvar|requirements>requirements.txt</> together with their dependencies.

To install dependencies for some script, use pip, and run the following command:

Alternatively, run the following command to install all dependencies for all scripts at once: