Manual:Pywikibot/Installation

From MediaWiki.org
Jump to: navigation, search

Other languages:
العربية • ‎български • ‎català • ‎čeština • ‎Deutsch • ‎Ελληνικά • ‎English • ‎español • ‎فارسی • ‎suomi • ‎français • ‎Bahasa Indonesia • ‎italiano • ‎日本語 • ‎한국어 • ‎Lëtzebuergesch • ‎Nederlands • ‎polski • ‎português • ‎português do Brasil • ‎русский • ‎українська • ‎中文
Gnome-system-software-installer.svg
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[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. If you have Python 2.7.2 or higher, or Python 3.3 or higher installed, your version of Python is recent enough.

Install dependencies[edit]

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 3.4 or higher. Run the following command to install this package:

pip install requests

Install Pywikibot[edit]

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

Unpack downloaded file, for example in /home/username/pywikibot or C:\Users\username\pywikibot.

Alternatively, you may retrieve the latest version using git 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.

Older versions are available at http://tools.wmflabs.org/pywikibot/.

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 /home/username/pywikibot
Windows:
c:
cd "\Users\username\pywikibot"

Of course 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 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 user-config.py. See config2.py for a list of all parameters you can use.

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]

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

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:

pip install [name of the package]

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

pip install -r requirements.txt