Manual:Pywikibot/Installation/nan

  Chit ia̍h ē pang-chō͘ lí khai-sí sú-iōng Pywikibot, tī lí ka-kī ê tiān-náu, tī Toolforge, ia̍h-sī ēng PAWS: Chi̍t ê Bāng-ia̍h Shell.

  Tī 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.

 Tī lí ka-tī ê tiān-náu Ē-kha sī pang-chō͘ lí tī ka-kī ê tiān-náu téng siat-tì kap cháu Pywikibot ê chheh. Chit-ê kòe-têng chú-iàu ū sì pō͘:  Tī Toolforge Toolforge tī Wikimedia server téng thê-kiong lí chi̍t ê ún-tēng ê cloud siat-si, hō͘ lí ē-sái liân-sòa ia̍h-sī chiàu kui-ōe cháu bot.
 * An-chong Python
 * An-chong Pywikibot
 * Phòe-tì Pywikibot
 * Cháu chi̍t ê kiàn-pún

An-chong Python
Ùi https://www.python.org/downloads/ hā-chài pēng an-chong Python.

Nā-sī lí í-keng ū an-chong Python, tī chi̍t ê console lāi-té cháu  lâi kiám-cha lí-ê pán-pún kám ū-kàu sin. To discover if Python version 3 or above is installed, run  in a console.

Ubuntu 19.04 and up comes with versions 2 & 3 installed. Python v2 runs by default using terminal command ; to use v3, use terminal command.

If you have installed, your version of Python is recent enough.

Tī Windows chhiáⁿ m̄-thang bōe-kì-tit ài siu-kái PATH khoân-kéng lâi hō͘ Python kap pip cháu liáu khah sūn.

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

In addition a MediaWiki markup parser is required. Please install (at least) one of them: or or both.

An-chong Pywikibot
Download current Pywikibot stable branch: .tar.gz, .zip.

Python 2.7 users should download the stable python2 branch: .tar.gz, .zip instead.

Unpack downloaded file, for example in  or.

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

Kî-thaⁿ pán-pún ē-sái tī https://pywikibot.toolforge.org/ chhú-tit.

Keng-sin 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 (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.

Phòe-tì 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 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 config.py for a list of all parameters you can use.

Proxy configuration
Pywikibot relies on  for communicating with the web. You can use  and   environment variables to make requests use a proxy server. Refer to requests' documentation for more info.

Cháu kiàn-pún
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 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:

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