Manual:Pywikibot/Installation

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

Install Python
Download and install Python from http://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.2 or higher installed, or Python 3.3 or higher, your version of Python is recent enough.

Install dependencies
An addidional package named requests is required to run pywikibot. Use pip, which is already installed if you have a Python release 2.7.9 or 3.4 or higher. Run the following commands to install this package:

Or, if using Windows command prompt, first add Python directory to your system environment variable, then

Downloading Pywikibot
Download Pywikibot master branch: .tar.gz, .zip.

Alternatively, nightly downloads are available at https://tools.wmflabs.org/pywikibot/.

Unpack this file, for example in  or.

Alternatively you may retrieve the latest version as git client or svn client from gerrit, see . This is the recommended way for active bot operators and developers to use pywikibot.

Updating
Keep your bot framework up to date. New versions are released continuously, and are available at the same location.

If you are using svn or git client repository you may skip this note. Otherwise please be aware that before installing a new release, backup your configuration files and scripts (, any family file, or custom script that you might have created, and any current dump XML file you're using for a wiki).

Unpack the new version over the old version, overwriting all files.

Configuring Pywikibot
Open a terminal and change directory (cd) to where you unpacked pywikibot.


 * Unix-like (Linux/BSD/Solaris): Start 'Terminal' (typically under 'System Tools' in the menu), and run:


 * Windows: Start 'Command Prompt' (typically under 'Accessories » System Tools' or 'System'), and run:

Of course substituting the location where you unpacked pywikibot.

Follow the prompts to configure pywikibot.

After this create somewhere file with text like, open user-config.py in Pywikibot folder and insert in this file   line.

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  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 'user-config.py'.

See config2.py for a list of all parameters you can use.

Running 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 .

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

These are listed in <tvar|requirements>requirements.txt</>.

To install dependencies, use <tvar|pip>pip</>, which is already installed if you have a recent version of Python. Run the following commands to install packages:

Or the following command to install all of the recommended packages: