מדריך:Pywikibot/התקנה

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page Manual:Pywikibot/Installation and the translation is 25% complete.

Outdated translations are marked like this.
Other languages:
Bahasa Indonesia • ‎Deutsch • ‎English • ‎Lëtzebuergesch • ‎Nederlands • ‎asturianu • ‎català • ‎dansk • ‎español • ‎français • ‎italiano • ‎norsk nynorsk • ‎polski • ‎português do Brasil • ‎suomi • ‎čeština • ‎Ελληνικά • ‎български • ‎русский • ‎українська • ‎עברית • ‎العربية • ‎فارسی • ‎ไทย • ‎中文 • ‎日本語 • ‎한국어
Gnome-system-software-installer.svg
דף זה יסייע לכם להתחיל להשתמש ב-Pywikibot, במחשב שלכם, או בשרת Toolforge או באמצעות PAWS: A Web Shell.
ב PAWS
Unicorn paw logo.svg

PAWS: A Web Shell הוא הדרך הפשוטה ביותר כדי להתחיל עם Pywikibot. לא נדרשת התקנה, וניתן להשתמש בדפדפן לשליחת פקודות.

במחשב האישי
Computer n screen.svg

דף זה יסייע לך להתקין ולהריץ Pywikibot במחשבך. יש ארבעה צעדים עיקריים בתהליך:

הרצה בשרת Toolforge
Toolforge logo.svg

Toolforge מספק שתחתית אחסון שמאפשרת להריץ בוטים בצורה מתמשכת או מתוזמנת.

התקנת פייתון

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

$ pip install requests

Install Pywikibot

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

Unpack downloaded file, for example in ~/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 users . This is the recommended way for active bot operators and developers to use Pywikibot.

Other versions are available at 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 (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):
$ cd ~/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

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

Proxy configuration

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

Run a script

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/Scripts .

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:

$ 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


If you need more help on setting up your Pywikibot visit the #pywikibot IRC channel connect or pywikibot@ mailing list.