Manual:Pywikibot/安装

这个页面将帮助你开始使用Pywikibot。您可以在您的个人计算机、Toolforge或PAWS: A Web Shell上使用Pywikibot。

在PAWS上

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

在PAWS上运行Pywikibot

在您的个人计算机上使用

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

• 安装Python
• 安装Pywikibot
• 配置Pywikibot
• 运行脚本

在Toolforge上

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

在Toolforge上运行Pywikibot

Pywikibot
快速概览 安裝 在PAWS上运行 在Windows上运行 在Toolforge上运行 配置和脚本 user-config.py 全局选项 生成器和过滤器选项 国际化 脚本 使用 说明文档 维基数据 非维基媒体wiki站点 开发 进一步帮助 更多… »

安装Python

从 https://www.python.org/downloads/ 下载并安装Python。 Make absolutely certain that you check the box at the bottom of the install wizard asking if you want to add Python to PATH! That will allow you to access Python from any command prompt just by typing the keyword python.

如果您已经安装了Python，请检查您的Python版本是否符合Pywikibot的要求。在主控台（windows上可用命令提示符）运行python --version即可获取版本号。 若要查看是否已安装Python 3或其更高版本，请在控制台中运行python3 --version。

Ubuntu 19.04及以上版本自带Python2，Python3两个版本。 Python2 默认使用终端命令 python 运行；要使用Python3，请使用终端命令 python3。

Python 3.7 or higher is currently required to run the bot, but Python 3.8 or higher is recommended. 在Windows中，不要忘记修改环境变量PATH，以確保Python和pip能正确运行。

安装依赖

Additional packages are required to run Pywikibot. Run the following command to install these packages:

$ python -m pip install "requests>=2.20.1"
$ python -m pip install "mwparserfromhell>=0.5.2"
$ python -m pip install packaging

For Python 3.7 an additional package is required. Install it with:

$ python -m pip install importlib_metadata

An alternate MediaWiki markup parser may be installed with:

$ python -m pip install "wikitextparser>=0.47.5"

See also https://doc.wikimedia.org/pywikibot/stable/introduction.html#quick-start

安装Pywikibot

$ python -m pip install pywikibot

如果您使用 pip，在下面的示例中请使用 pwb 而不是 python pwb.py。

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

解压下载的文件，例如解压到~/pywikibot或%USERPROFILE%\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 "%USERPROFILE%\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中修改这些选项。 参见config.py以获取您可以使用的所有参数列表。

Proxy（代理服务器）配置

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

运行脚本

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

$ python pwb.py [name of the script]

To learn more about running basic Pywikibot scripts, see:

• Small wiki toolkits workshop about running basic Pywikibot scripts
• Self-study materials based on the small wiki toolkits workshop
• Workshop handbook based on the small wiki toolkits workshop

所有可用脚本的列表可在 Manual:Pywikibot/脚本 和 doc.wikimedia.org/pywikibot 查看。

其他依赖性

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

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

$ python -m pip install [name of the package]

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

$ python -m pip install -r requirements.txt

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