ウィキペディア日本語版のヘルプページです。pywikipediabotを準備するのに手助けがほしいなら#wikipedia-ja-bot接続（詳しくはWP:CHATを参照） にくるかpywikipediabot mailing listを使ってください。.mw-parser-output .ombox{margin:4px 0;border-collapse:collapse;border:1px solid #a2a9b1;background-color:#f8f9fa;box-sizing:border-box}.mw-parser-output .ombox.mbox-small{font-size:88%;line-height:1.25em}.mw-parser-output .ombox-speedy{border:2px solid #b32424;background-color:#fee7e6}.mw-parser-output .ombox-delete{border:2px solid #b32424}.mw-parser-output .ombox-content{border:1px solid #f28500}.mw-parser-output .ombox-style{border:1px solid #fc3}.mw-parser-output .ombox-move{border:1px solid #9932cc}.mw-parser-output .ombox-protection{border:2px solid #a2a9b1}.mw-parser-output .ombox .mbox-text{border:none;padding:0.25em 0.9em;width:100%;font-size:90%}.mw-parser-output .ombox .mbox-image{border:none;padding:2px 0 2px 0.9em;text-align:center}.mw-parser-output .ombox .mbox-imageright{border:none;padding:2px 0.9em 2px 0;text-align:center}.mw-parser-output .ombox .mbox-empty-cell{border:none;padding:0;width:1px}.mw-parser-output .ombox .mbox-invalid-type{text-align:center}@media(min-width:720px){.mw-parser-output .ombox{margin:4px 10%}.mw-parser-output .ombox.mbox-small{clear:right;float:right;margin:4px 0 4px 1em;width:238px}}

2017年2月現在、このページの内容は既に廃れています。「mw:Manual:Pywikibot/ja」をご覧ください。

2010年9月10日頃、名前空間名に変更が加えられました。この変更に対応しているのは r8523 以降のリビジョンです。
pywikipediabot動作画面例。言語間リンクを貼っているところ。

Pywikipediabot (Python Wikipedia Robot Framework) は、ウィキペディアなどのウィキメディア財団のプロジェクトのためのBotスクリプトのセットです。多くの開発者によってPython言語で記述されています。このページでは、Botソフトウェアを使用したい人のためのおおまかな情報を提供します。
セットアップ

Macを使用する場合は、こちらをお読みください。

Pythonのインストール

pywikipediaを使うためには、Pythonバージョン2.4以上が必要です。Pythonバージョン2.3で動くコードも多いですが、2.3での動作確認は行われていません。ただし2011年1月現在、バージョン3には対応していません。

Pythonは、ほとんどのプラットフォーム（Unix、Linux、Mac、Windows）で使えます。

WindowsにはActivePythonが便利ですが、やや遅いです。ここからダウンロードできます。

Unixには最初からPythonがインストールされているので、インストールする必要はありません（ただし、非常に古いバージョンのUnixの場合には、Pythonがインストールされていなかったり、Pythonのバージョンが古かったりする場合があります。その場合にはアップデートが必要です）。

MacでMac OS Xを使っている場合は、インストールの必要はありません。

その他の場合、あるいはインストールされているバージョンが古い場合には、https://www.python.org/downloads/ からダウンロードしてインストールしてください。

pywikipediaのダウンロード

最も簡単な方法は、 ⇒PyWikipediaBot PyWikipediaBot Nightliesの「pywikipedia - The packages」からダウンロードすることです（ただしこのファイルは前日の時点での最新版です）。古いバージョンが必要な場合はSourceforgeからダウンロードできます。ダウンロードしたファイルを展開します。展開する場所は、できるだけ浅い位置のディレクトリが便利でしょう。

Mac OS Xの場合には、ここにある説明をお読み下さい。ファイルはここからダウンロードできます。"Check out"でコピーが可能です。
SVNを使ったダウンロード

（上記の前日の時点の最新バージョンではなく）最新のバージョンをダウンロードしたい場合には、SVNが便利です。SVNを使うと、日頃のバージョンアップも非常に簡単です。多くのUnixにはSVNが標準でインストールされています。Windowsの場合は ⇒TortoiseSVNを利用しましょう（Microsoft Windows 7の場合は64ビット版がよいでしょう）。Mac OS Xの場合は ⇒この説明を読んでください。

Unixなどで、コマンドラインを使ってBotをチェックアウト（ダウンロード）するには、以下のコマンドを使用します：$ svn checkout http://svn.wikimedia.org/svnroot/pywikipedia/trunk/pywikipedia/ pywikipedia

次のようにファイルのスペルチェックを無効にすると時間短縮になります：$ svn checkout --ignore-externals http://svn.wikimedia.org/svnroot/pywikipedia/trunk/pywikipedia/ pywikipedia

上のコマンドを実行すると、カレント作業ディレクトリ（Unixではpwdコマンドか変数$PWDで確認、Cygwinなど他の環境では環境設定で確認できます）に「pywikipedia」という名前で新しいディレクトリが作成されます。

コマンドラインを使ってダウンロードしたファイルを後日アップデートするには、作業ディレクトリをpywikipediaに移動してから、以下を打ちます。$ svn update

TortoiseSVNなど、コマンドラインツール以外では必要な情報はリポジトリのパスのみです：http://svn.wikimedia.org/svnroot/pywikipedia/trunk/pywikipedia/
Botのメーリングリスト

Botメーリングリストに登録するのは、良い考えでしょう（こちらを参照）。Botソフトウェアのファイルが更新されるたびにリストにメールが送られるので、新しいバージョンにアップデートする必要があるかどうか確認できます。
アカウント取得

ボットの運用条件や注意事項については Wikipedia:Bot を参照してください。

大規模な編集を行う場合は、Botのアカウントは通常の利用者と区別するため、専用のアカウントを取得しなければなりません。これは、Botフラグを付与することで最近更新されたページからBotの編集を隠すためです。ウェブブラウザを使ってあなた自身が手動で取得してください。利用者名は、通常「bot」の文字が後ろに付けられることが推奨されます。パスワードはあなた自身のアカウントと別のものがよいでしょう。
user-config.py の設定

編集可能な環境変数の初期値は config.py にあります。これを直接書き換えるとSVNでのアップデートで支障が出ることがあるため、お勧めできません。値を変更する場合には、同じ階層に user-config.py を作成します。user-config.py だけで設定を上書きしていくことで、初期値に戻したい場合、削除することで対応できます。
アカウントに関する設定

以下の節では、アカウントに関する設定について説明しています。なお、testfamily.py というプログラムがある場合は、実行することで簡易設定を行うことができます。（説明省略）
ウィキペディアの場合

メモ帳などのテキストエディタを開きます。

以下のように打ちます： mylang = 'xx'

xx には、動作させる言語コードが入ります。日本語版では、"ja"が入ります。

このテキストファイルをuser-config.pyという名前で、ダウンロードしたpyファイルと一緒のフォルダに保存します。

複数の言語で動作させたいなら、コマンドライン引数の-langパラメータで指定できるので、ここでは最もよく使う言語コードを指定しましょう。

user-config.pyでは、Botの利用者名を指定する必要があります。

ウィキペディア日本語版で動作させるとします。「ExampleBot」という利用者名でBotのアカウントを取得しているならば、以下のようにuser-config.pyに追記します。 usernames['wikipedia']['ja'] = u'ExampleBot'

利用者名の前の'u'は、Unicodeを表しています。詳しくは Python 自体のヘルプを見てください。

複数のwikiで動作させたいなら、以下のように複数の利用者名を指定できます。 usernames['wikipedia']['de'] = u'BeispielBot' usernames['wikipedia']['en'] = u'ExampleBot' usernames['wiktionary']['de'] = u'BeispielBot'

管理者権限が必要なスクリプト(speedy_delete.py、redirect.py brokenなど)は、以下のように管理者権限を持つアカウントを追記します。 sysopnames['wikipedia']['ja'] = u'SysopName'
ウィキペディア以外のウィキサイトの場合

メモ帳などのテキストエディタを開きます。

以下のように打ちます：mylang = 'xx'

xx には、動作させる言語コードが入ります。日本語では、"ja"が入ります。

次に以下のように打ちます：family = 'sitename'

"sitename"は、動作させるサイト名です。

wiktionary、wikibooks、wikiquoteなどやウィキメディア・プロジェクトではないwikitravelなども指定できます。（familiesフォルダに一覧があります。）

Wikimedia Commonsで動作させるなら、"mylang"と"family"に'commons'を指定します。 mylang='commons' family='commons' usernames['commons']['commons']='UserBot'
familyフォルダにウィキサイトが無い場合

ウィキが family フォルダのリストに無い場合は、適切な _family.py ファイルを作成する必要があります。作成に関する説明は省きますので、meta:Pywikipedia bot on non-Wikimedia projectsを参照してください。

この場合でも user-config.py の設定を行ないます。

ウィキ名 Memory Alpha (memoryalpha) の英語版 (en) で動作させるとします。「ExampleBot」という利用者名でBotのアカウントを取得しているならば、以下のように記述します: mylang = 'en' family = 'memoryalpha' usernames['memoryalpha']['en'] = u'ExampleBot'

このテキストファイルをuser-config.pyという名前で、ダウンロードしたpyファイルと一緒のフォルダに保存します。
その他の設定

当面は安全のため、ボットの速度を落としましょう。user-config.py に put_throttle = 30 いう行を追加します。これはPywikipediaBotの編集間隔の秒数です。デフォルトは10です。

ウィキペディア日本語版では、どんなに早い場合でも10秒以上（毎分6回）の間隔を守らなくてはなりません。Botフラグ無し、かつ、大量編集する場合には60秒以上の間隔を求められます。