手册:Pywikibot/安装

This page is a translated version of the page Manual:Pywikibot/Installation and the translation is 100% complete.
这个页面将帮助你开始使用Pywikibot。您可以在您的个人计算机、Toolforge或PAWS: A Web Shell上使用Pywikibot。
Gnome-system-software-installer.svg
PAWS
PAWS (no text).svg

PAWS: A Web Shell 是最简单的入门Pywikibot的方式。 不需要安装,使用一个网页即可提交命令。

在您的个人计算机上使用
Computer n screen.svg

下列手册将帮助您在个人计算机上安装和运行Pywikibot。以下是四个主要步骤:

Toolforge
Toolforge logo.svg

Toolforge在维基媒体服务器上为您提供稳定的基础设施,在这里你可以持续或定期运行机器人。

安装Python

从https://www.python.org/downloads/下载并安装Python。

如果您已经安装了Python,请检查您的Python版本是否符合Pywikibot的要求。在主控台(windows上可用命令提示符)运行python --version即可获取版本号。 如果您已安装Python 3.5 or higher ,那么您的Python版本足够新了。

在Windows中,不要忘记修改环境变量PATH,以確保Python和pip能正确运行。

安装依赖

运行Pywikibot需要一个额外的“requests”依赖。需使用pip,如果您已安装Python 2.7.9或更高版本,或Python 3.4或更高版本,那么它已安装。运行以下命令安装该依赖:

$ pip install "requests>=2.20.1"

安装Pywikibot

下载当前的Pywikibot stable分支:.tar.gz, .zip

Python 2.7用户应改為下载稳定版python2分支:.tar.gz, .zip

解压下载的文件,例如解压到~/pywikibotC:\Users\username\pywikibot

又或者,您可以使用git或svn客户端从Gerrit獲取最新版本,参见手册:Pywikibot/Gerrit 。推荐活跃机器人使用者及开发者使用这种方法操作Pywikibot。

其它版本可在https://pywikibot.toolforge.org/找到。

更新Pywikibot

確保您的机器人框架是最新版本。新版本会连续发布,并在同一位置可用。

如果您在使用git或svn发行版本,您可以跳过此注释。否则请尤其注意,在安装新版本前,請務必备份您的配置文件和脚本(“user-config.py”、任何family文件或任何您可能创建或更改的自定义脚本,以及任何当前您为某一wiki使用的XML转储文件)。

解压新版本,並覆盖所有旧版本的文件。

配置Pywikibot

在类Unix系统(Linux/BSD/Solaris)上打开“终端”,或在Windows上打开“命令提示符”(一般在“Windows”系统或“所有应用”中的“附件”文件夹,或是开始菜单中的“所有程序”菜单中),并移動至您解压Pywikibot的目录。

类Unix(Linux/BSD/Solaris)
$ cd ~/core
Windows
$ c:
$ cd "\Users\username\pywikibot"

請将路径替换为您解压Pywikibot的路径。

继续输入以下命令以生成用户配置文件:

$ python pwb.py generate_user_files

根据提示来配置Pywikibot。

最后运行以下命令以登录您的wiki:

$ python pwb.py login

在第三方wiki上使用

Pywikibot已經预先配置好了很多维基网站,但也许不適用於你想要處理的那一个。 查看Manual:Pywikibot/Use on third-party wikis 来確認如何为你自己處理的维基网站配置Pywikibot。

更多配置选项

Pywikibot提供了许多选项来改变你的机器人行为。 你可以在user-config.py中修改这些选项。 参见config2.py以获取您可以使用的所有参数列表。

Proxy(代理服务器)配置

Pywikibot使用requests与网络通信。 你可以使用环境变量HTTP_PROXYHTTPS_PROXY讓requests使用指定的代理服务器。 更多信息請见requests的文档

运行脚本

Pywikibot在scripts目录下储存了大量的脚本。 您可以通过以下指令运行它们:

$ python pwb.py [name of the script]

所有可用脚本的列表可在手册:Pywikibot/脚本 查看。

其他依赖性

大多数脚本不需要额外的依赖,但也有少部分没有安裝依赖就无法工作。 requirements.txt中列出了这些脚本及其依赖。

要为脚本安装其依赖,使用pip运行以下命令即可:

$ pip install [name of the package]

或者,运行下面的命令来为所有脚本一次安装所有依赖:

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