Manual:Pywikibot/インストール
自分のコンピュータにPywikibotをセットアップして実行するためのマニュアルです。この過程には主に4つの手順があります。
 |
| Pywikibot |
|---|
|
Pythonのインストール
https://www.python.org/downloads/ からPythonをダウンロードしてインストールしましょう。
インストールウィザードで、「Add python.exe to PATH」にチェックを入れることをお忘れなく！
そうすることで、コマンドシェルからpython3またはpythonと入力するだけでPythonを実行することが可能になります。
すでにPythonをインストール済みの場合、コンソールでpython --versionを実行してpywikibotの動作に必要なバージョンがインストールされているかどうかを確認することができます。
Python 3以降がインストールされているかどうかを確認するには、コンソールで python3 --versionを実行します。
Ubuntu 19.04 以降には、Python 2と3がプリインストールされています。
Python 2は、端末コマンドpythonを使用して既定で実行されます。Python 3 を使用するには、端末コマンドpython3を使用します。
現在、このボットを実行するには Python 3.9 以降が必要ですが、Python 3.10 以降を推奨します。 Windowsでは、Pythonやpipコマンドが正しく動作するように、Pythonのbinディレクトリを環境変数PATHに登録することを忘れないようにしましょう。
依存関係のインストール
Pywikibotの実行には、追加のパッケージが必要です。 以下のパッケージをインストールするために、次のコマンドを実行してください。
python3 -m pip install "requests>=2.20.1"
python3 -m pip install "mwparserfromhell>=0.5.2"
python3 -m pip install packaging
Pywikibotの公式ドキュメント（2025年時点の最新仕様を含む）によると、Python 3.7環境では以下のパッケージのインストールが指定されています。 以下のコマンドを使用してインストールしてください:
python3 -m pip install importlib_metadata
代替のMediaWikiマークアップパーサは、以下のコマンドでインストールできます。
python3 -m pip install "wikitextparser>=0.47.5"
See also https://doc.wikimedia.org/pywikibot/stable/introduction.html#quick-start
Pywikibot のインストール
Recommended
python3 -m pip install pywikibot
pipを使用する場合、以下の例ではpython3 pwb.pyの代わりにpwbを使用してください。
Alternatives
最新の Pywikibot stable ブランチ: .tar.gz, .zip をダウンロードしてください。
ダウンロードしたファイルを、例えば ~/pywikibot または %USERPROFILE%\pywikibot に展開してください。
あるいは、最新版を git クライアントから手に入れたい場合は、Manual:Pywikibot/Gerrit をみてください。 Pywikibot を使った作業や開発を行う場合は、この方法を推奨します。
その他のバージョンは https://pywikibot.toolforge.org/ から入手できます。
Pywikibot の更新
Pywikibotを最新に保ってください。新しいバージョンは随時リリースされており、以前にダウンロードした際と同じ場所から入手することができます。
git を利用してPywikibotを入手した場合は、この節は飛ばしても構いません。
ただし、新しいバージョンをインストールする前に、設定ファイルとスクリプト (user-config.py、familyファイル、自作したカスタムスクリプト、ウィキで使用している現在のXMLファイルのダンプ) のバックアップをとることは重要です。
旧バージョンのある場所に、新バージョンを展開してください。ファイルは全て上書きされます。
Pywikibotの設定
Unixライク（Linux／BSD／Solaris）ならターミナルを、Windowsならコマンドプロンプト（"Windows System"／"全てのアプリケーション"の中の"アクセサリ"フォルダ／スタートメニューの中の"全てのプログラム"以下にあります）を開いて、あなたがpywikibotを解凍した場所にディレクトリを変更しましょう。
Unix系（Linux/BSD/Solaris）：
cd ~/core
- Windows (Command Prompt, not PowerShell):
c: cd "%USERPROFILE%\pywikibot"
当然ですが、（上記の例は）あなたがpywikibotを解凍した場所に置き換えてください。
ユーザ設定ファイルを生成するため以下のコマンドを続けて下さい：
python3 pwb.py generate_user_files
pywikibotを設定する為にプロンプトに従いましょう。 create a passwordする必要があります。
最後に、次のコマンドを入力することで、あなたの wiki にログインできます。
python3 pwb.py login
サードパーティーのwikiで使用するには
Pywikibotには、数多くのウィキに対する設定ファイルが標準で含まれていますが、あなたが使用したいウィキの設定ファイルがない場合もあろうかと思います。 あなたのウィキ用にPywikibotを設定をする方法についてはManual:Pywikibot/Use on third-party wikisをご覧ください。
その他の設定オプション
あなたのボットの挙動を変更できるように、Pywikibotには幅広い設定オプションがあります。
これらの設定は、ファイル user-config.py で変更できます。
あなたが使用可能なパラメーターのリストはconfig.pyをご覧ください。
プロキシの設定
Pywikibot は、ウェブとの通信に requests を使用しています。
プロキシ サーバーを使用するようにするには、環境変数 HTTP_PROXY および HTTPS_PROXY を設定してください。
詳細については、requestsのドキュメントを参照してください。
スクリプトの実行
Pywikibotには数多くの付属スクリプトが提供されており、scriptsディレクトリにまとめてあります。 あなたはそれらを全て使う事が出来ます
python3 pwb.py [name of the script]
基本的なPywikibotスクリプトの実行方法に関する詳細は、以下を参照してください。
- 基本的なPywikibotスクリプトの実行に関する、Small Wiki Toolkits（SWT）ワークショップ
- Small Wiki Toolkits（SWT）ワークショップに基づく自習用教材
- Small Wiki Toolkits（SWT）ワークショップに基づくワークショップ・ハンドブック
スクリプトの一覧はManual:Pywikibot/スクリプトおよびdoc.wikimedia.org/pywikibotから入手できます。
その他の依存関係
ほとんどのスクリプトには動作に追加パッケージは不要ですが、いくつかは動かない物があります。 それらは依存パッケージと共に requirements.txt でリストされています。
依存パッケージをインストールするには、$pipを使用し、以下のコマンドを実行しましょう。
python3 -m pip install [name of the package]
もしくは全ての推奨パッケージを一度にインストールするために以下のコマンドを実行しましょう。
python3 -m pip install -r requirements.txt
- ご使用の Pywikibot のセットアップにさらなるヘルプが必要な場合は、IRC チャンネル #pywikibot 接続 または pywikibot@ メーリング リストにお問い合わせください。