Pywikipediabot使用手冊

Add links
From Meta, a Wikimedia project coordination wiki
This is an archived version of this page, as edited by Alexsh (talk | contribs) at 03:31, 16 June 2008 (→‎透過SVN下載). It may differ significantly from the current version.

In other languages: de - en - fr - hu - it - ja - ko - nl - pl - pt - ru - sv - zh-hant

Python Wikipediabot Framework (pywikipedia)是一組針對維基百科或維基媒體計劃等以MediaWiki架設的網站的自動執行更新工具。本頁將提供如何使用本軟體的一般資訊。

初始設定

PyWikipediaBot是使用Python撰寫而成的程式，您需要安裝最新版的Python程式到您的電腦中才可以執行Pywikipediabot。部份程式雖可以在Python 2.3版執行，但目前沒有計劃相容舊版本的Python。

ActivePython

ActivePython可以於任何的平臺上運作(Unix, Linux, Mac, Windows)，它也可以執行Pywikipediabot的程式碼。

  • windows系統：連結到這裡下載並安裝ActivePython
  • Unix系統：一般來說，Python會預設安裝在大部份的Unix版本，因此不需要下載(除非您系統的Python版本太舊才需要)
  • 在Macintosh，Python已包含在Mac OS X中

下載

使用這個網站可以很輕易的下載到最近的Pywikipediabot版本。過去的舊版本可以在Sourceforge找到。下載並解壓縮這些檔案即可，不需要再做其他安裝手續。

Macintosh電腦請參閱此教學。Pywikipediabot的檔案可以在這裡找到。[1]

透過SVN下載

您可以使 用 SVN ([1] subversion.tigris.org)取得即時更新的Pywikipediabot資料。如果您使用Windows系統，我們建議您使用TortoiseSVN。Macintosh電腦可以參閱這個網頁

透過SVN取得原始碼的指令如下：

$ svn checkout http://svn.wikimedia.org/svnroot/pywikipedia/trunk/pywikipedia/ pywikipedia

如果不想取得拼音檢查的檔案，請輸入以下指令： 

$ svn checkout --ignore-externals http://svn.wikimedia.org/svnroot/pywikipedia/trunk/pywikipedia/ pywikipedia

In your current working directory there’s now created a new directory named “pywikipedia”.

For non command line tools, the only information needed is the repository path: http://svn.wikimedia.org/svnroot/pywikipedia/trunk/pywikipedia/

Configuration

You do not need to "install" this package to be able to make use of it. You can actually just run it from the directory where you unpacked it or where you have your copy of the SVN sources.

Before you run any of the programs, you need to create a file named user-config.py in your pywikipedia directory. You can create it manually (it needs at least two or three varibles configured) or run the script generate_user_files.py that helps to complete this process.

Please note, PyWikipediaBot assumes your account uses the default Monobook skin, don't change it in your MediaWiki account setting if you want the bot to work properly.

Configuration for Wikipedia

Open a text editor (e.g. Notepad in Windows) and save the text file as user-config.py, in the pywikipedia folder.

Add the following two required lines to user-config.py:

Code Explanation 
mylang = 'xx'

xx is the code for the language code you are working on, "en" is English.[2] 

usernames['wikipedia']['en'] = u'ExampleBot'[3]

Your user-config.py file needs to specify the bot's username.

In this example, the user is working on English Wikipedia, and has created a bot account with the username "ExampleBot".

(Optional) 

usernames['wikipedia']['de'] = u'BeispielBot'
usernames['wikipedia']['en'] = u'ExampleBot'
usernames['wiktionary']['de'] = u'BeispielBot'

(Optional)

If you are working on more than one wikipedia project, you can also add several other usernames.

Now save user-config.py again.

Configuration for other MediaWiki wikis

Add the following three required lines to user-config.py:

Code Explanation 
mylang = 'xx'

xx is the code for the language code you are working on, "en" is English.[2] 

family = 'sitename'

"Sitename" is the name of the site you're working on.

Currently, this can be wiktionary, wikibooks, wikiquote, as well as some non-Wikimedia projects like wikitravel (the full list is found in the pywikipedia/families folder). 

usernames['memoryalpha']['en'] = u'ExampleBot'

Your user-config.py file needs to specify the bot's username.

For example, if you want to work on the English Memory Alpha, and you have created a bot account with username "ExampleBot".

(For Wikimedia Commons only) 

mylang='commons'
family='commons'
usernames['commons']['commons']='UserBot'

(For Wikimedia Commons only)

If you work on Wikimedia Commons, specify commons both as language and as family.

Now save user-config.py again.

If your wiki is not listed in the families folder, create your own families .py file, see Pywikipedia bot on non-Wikimedia projects.

Configuration for non-wikimedia projects

Refer to the article Pywikipedia bot on non-wikimedia projects for instructions on how to configure the bot to use it on your own mediawiki-powered project.

Permission on wiki projects

Make sure that your bot is approved by the wiki community where you are going to use it. Strictness of this differs greatly between various projects; at some you need to announce it in advance and get approval before you start, at others you can do whatever you want.

Using your normal browser, create a login name and password for the bot. It is best to use a name that makes clear that it is a bot, and preferably also who is operating it. A common method is to use your own login name and add the word 'bot' to it, but several other forms also exist.

On the English Wikipedia, bots are only allowed to be used if they are approved at en:Wikipedia:Bots/Requests for approval.

Request a bot flag

If you heavily use a bot, it will clutter recent changes. To avoid that, you can get your bot registered as such. In that case it will not be shown on Recent changes unless a user specifically asks to get bots included.

This can be done by a Bureaucrat. You can put a request to get your or someone else's bot registered at Requests for bot status. You will probably be asked for some kind of evidence that your local community agrees with your bot. On the English language Wikipedia, requests should be made at Requests for approvals. It is probably good to get your bot registered whenever it will edit many pages in a single run.

Use

Select and run a bot script

Now we are ready to really start using the bot. You need to get to a textual interface to your Operating System.

On Windows this is done by opening the start menu, and clicking on 'Run'. You are asked to give the name of a program, type "cmd.exe".

  • Change the root to C: by typing chdir C:\
  • Type chdir \"name of the folder where pywikipedia bot has been downloaded" (For example: chdir \"pywikipedia" if the file is in the C: folder.)

On Mac, find Terminal.app in /Applications/Utilities.

On Linux or any other Unix, use any terminal application such as gnome-terminal, konsole, xterm, or simply the text-mode console.

Run the script login.py by typing "python login.py".

Python will then return:

Checked for running processes. 1 processes currently running, including the current process.
Password for user your_bot on your_site:en:

Use the password you used for the bot's login name. The bot can't work anonymously. Unless you change your password, you normally need to run this program only once, the bot usually does not get logged off.

The bots are in the main pywikipedia folder when downloaded. But it necessary, use the command cd to go to the directory where the bot files are saved.

Now run any of the bots here by typing "python botname.py" (If you are using Windows, you can leave out "python").

Scripts

Here is a list of the existing bots with links to their descriptions:

  Main bot scripts   Other bot scripts  

Auxiliary programs

Command-line arguments

Although many bot scripts have their own command line arguments, which should be documented on their respective pages (or in their source code), all bots unless specifically stated to the contrary recognize the following command line arguments:

-help
Print a list of global bot arguments (this list), followed by bot-specific help if available.
-lang:xx
Set the language of the wiki you want to work on to language code xx, overriding the configuration in user-config.py.
-family:xyz
Set the family of the wiki you want to work on, e.g., wikipedia, wiktionary, wikitravel, ... This will override the configuration in user-config.py.
-log
Enable the logfile. Logs will be stored in the logs subdirectory.
-log:xyz
Enable the logfile, using xyz as the filename.
-nolog
Disable the logfile (if it's enabled by default).
-putthrottle:nn
Set the minimum time (in seconds) the bot will wait between saving pages. The default value is 10.

For example, python scriptname.py -family:wiktionary will run the "scriptname" bot on wiktionary articles, overriding the default family setting in your user configuration.

Bot mailing list

It can be useful to subscribe to the bot mailing list (see http://lists.wikimedia.org/mailman/listinfo/Pywikipedia-l). Every time a file of the bot software is changed, a mail is sent to the list, so you know when you need to update to the new version.

Update

For further updates chdir into 'pywikipedia' and type

$ svn update

On a Mac, you can write the following:

svn update pywikipedia

How to report a bug

When you report a bug please try to include:

  • PyWikipediaBot version in use. It's recommended to test if the bug is still present in latest SVN revision available.
  • Python version (python -V) and operating system you use (e.g. Windows, Linux, MacOS...)
  • A nice summary
  • Full description of the problem/report
  • How to reproduce bug full information (script, command line, family, and language used)
  • Output data

To submit a new bug visit the bug tracker provided by SourceForge.

Development

If you have a function you want to have a bot for that is not yet provided by one of the bots, you can ask one of the programmers to write it for you. Or even better, you can try to work on the bots yourself. Python is a nice language, and not hard to learn. We will welcome you.

Tips

Here and in wikipedia.py, there are some very basic tips for getting started writing your own bot:

  • be sure you've set up your user-config.py file (see above)
  • To gain access to the pywikipedia framework, use:
import wikipedia
  • to retrieve a page, use the following, where pageName is, e.g., "Wikipedia:Bots" or "India":
site = wikipedia.getSite()
page = wikipedia.Page(site, u"pageName")
text = page.get(get_redirect = True)
  • to update a page, use:
page.put(u"newText", u"Edit comment")
  • look at some of the pywikipedia files for other ideas -- basic.py is relatively easy to read even if you're new to pywikipedia.
  • you can find all available Page methods in the wikipedia.py file.
  • basic.py gives you a setup that can be used for many different bots, all you have to do is define the string editing on the page text.
  • To iterate over a set of pages, see pagegenerators.py for some objects that return a set of pages. An example use of the CategoryPageGenerator that does something for each page in the Category:Living people category:
import catlib
import pagegenerators
site = wikipedia.getSite()
cat = catlib.Category(site,'Category:Living people')
gen = pagegenerators.CategorizedPageGenerator(cat)
for page in gen:
  #Do something with the page object, for example:
  text = page.get()

Create a quick shortcut to run commands (Windows users)

How to make a quick shortcut to run commands (Windows users).

If you're installing Pywikipediabot in a folder such as "My Documents" it may be troublesome to use the "cd" command to go into the folder all the time to run the bots (For those who don't get what that means, this will help you a lot).

On Windows you can create a shortcut which will open the command box you can use to run bots easily. Just follow these simple steps to create one:

  1. Open up the folder pywikipedia is installed in, in a window.
  2. Under File > New select Shortcut.
  3. Type in "cmd.exe" and hit next.
  4. You can give a name to the shortcut here, just "Pywikipediabot" is good.
  5. In the address bar (The text bar above where your files are which tells you where you are) copy the path there.
  6. Right click on the new shortcut and hit properties and paste that path you copied into the "Start in" text field.
  7. Hit ok, and now you have a shortcut to open the command line to run bots from.

Contributing changes

If you changed the bot and want to send a patch to the maintainer,

  1. Update to the current version (it will merge your changes with the improvements already committed to the SVN Repository),
  2. Resolve any conflicts caused by the update (grep for "=====" ;-) and
  3. Type:
$ svn diff > svn.diff

Review the diff to ensure it only includes the changes you want to contribute. The lines at the beginning starting with "?" should be removed.

If you are in direct contact with a Pywikipediabot developer, you can send the file svn.diff to him, but preferably attach the patch to a ticket in the Pywikipedia bug tracking system.

Multiple accounts

It is a common need to run python wikipedia bot under different accounts (main and/or multiple bot accounts). It can be done in two ways.

Separate pywikipedia distributions

One can install completely separate instances of pywikipedia in different directories (1 for each account) and have diferent user-config.py files in each of them. However, when updating the installation via SVN, one needs to run svn update on each folder separately. Also, every installation takes some disk space, which might be a problem on accounts with limited quota.

One pywikipedia distribution with symbolic links

Let's assume user foo has a current SVN working copy of pywikipedia in /home/foo/pywikipedia. For each of the accounts, he creates a separate directory: 

foo@bar:~$ mkdir foobot
foo@bar:~$ cd foobot

Pywikipedia needs then some symlinks to the main code tree created in the working directory: 

foo@bar:~/foobot$ ln -s ~/pywikipedia/families
foo@bar:~/foobot$ ln -s ~/pywikipedia/userinterfaces

Then, user-config.py for this account must be created as described in Configuration section above.

Finally, the bot must be logged in the usual way: 

foo@bar:~/foobot$ python ~/pywikipedia/login.py

The working directory is ready. The scripts will however require a slight modification to run (the path to the pywikipedia tree must be added to Python's path). 

import sys, os
sys.path.append(os.environ['HOME'] + '/pywikipedia')
import wikipedia

That's all. Updating to the newest version of pywikipedia on all account at once is now a matter of running svn update only in the ~/pywikipedia directory.

Bot & Proxy

There is probably (not tested!) draft workaround described here.

Notes

  1. ↑ "Check out"是將這些檔案從儲存庫上複製一份並取去的意思。
  2. ↑ a b If you want to work with more than one language, choose the most common one, as you can override configured value in command line by -lang parameter.
  3. ↑ The 'u' in front of the username stands for Unicode. The 'u' is important if your username contains non-ASCII characters.

See also

External links


Retrieved from "https://meta.wikimedia.org/w/index.php?title=Pywikipediabot使用手冊&oldid=1044625"