Jump to: navigation, search
Translate this page; This page contains changes which are not marked for translation.

Other languages:
العربية • ‎català • ‎Deutsch • ‎Ελληνικά • ‎English • ‎español • ‎فارسی • ‎suomi • ‎français • ‎Bahasa Indonesia • ‎italiano • ‎日本語 • ‎한국어 • ‎Lëtzebuergesch • ‎Nederlands • ‎polski • ‎português • ‎português do Brasil • ‎русский • ‎українська • ‎中文

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

Unicorn paw logo.svg

Pywikibot: 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
Computer n screen.svg

This page will get you started installing and running Pywikibot on your own computers. There are four main steps to this process:

  • Installing Python
  • Downloading Pywikibot
  • Configuring Pywikibot
  • Running a script
Tool labs logo.svg

If you want to run a bot on a Wikimedia wiki, consider using Tool Labs. Tool Labs provides you with a stable hosting infrastructure that allows you to run bots continuously or on a schedule.

Install Python[edit]

Download and install Python from

If you already have Python installed, check if your version is recent enough by running python --version 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[edit]

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:

pip install requests

Downloading Pywikibot[edit]

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

Alternatively, nightly downloads are available at

Unpack this file, for example in /home/username/pywikibot or c:\users\username\pywikibot.

Alternatively you may retrieve the latest version as git client or svn client from gerrit, see Manual:Pywikibot/Gerrit#For usersManual:Pywikibot/Gerrit#For users. This is the recommended way for active bot operators and developers to use pywikibot.


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[edit]

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:
$ cd /home/username/pywikibot
$ python login
Windows: Start 'Command Prompt' (typically under 'Accessories » System Tools' or 'System'), and run:
> c:
> cd "\users\username\pywikibot"
> python login

Of course substituting the location where you unpacked pywikibot. Follow the prompts to configure pywikibot.

After this create somewhere file with text like ("en", "wikipedia", "User", "password"), open in Pywikibot folder and insert in this file password_file = "path_to_password_file" line.

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 wikisManual: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 ''. See for a list of all parameters you can use.

Running a script[edit]

Pywikibot comes packaged with a large number of scripts in the scripts directory. You can run all of these using

python [name of the script]

A list of all scripts is available at Manual:Pywikibot/ScriptsManual:Pywikibot/Scripts.

Other dependencies[edit]

Most scripts work do not require additional packages other then requests, but a few of them will not work without. These are listed in requirements.txt.

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

pip install package-name

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

pip install -r requirements.txt