Manual:Pywikibot/インストール
自分のコンピュータにPywikibotをセットアップして実行するためのマニュアルです。この過程には主に4つの手順があります。
Pythonのインストール
https://www.python.org/downloads/ からPythonをダウンロードしてインストールしましょう。
すでにPythonをインストール済みの場合には、端末でpython --versionを実行することにより、pywikibotの動作に必要なバージョンがインストールされているかどうかを確認することができます。
Pythonバージョン3以降がインストールされているかどうかを確認するには、コンソールで python3 --versionを実行します。
Ubuntu 19.04 以降には、バージョン2と3がインストールされています。
Pythonバージョン2は、端末コマンドpythonを使用してデフォルトで実行されます。バージョン3 を使用するには、端末コマンドpython3を使用します。
Python 3.7 or higher is currently required to run the bot. Windowsでは、Pythonやpipが正しく動作するように、環境変数PATHを変更することを忘れないようにしましょう。
依存関係のインストール
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を使用する場合、以下の例ではpython pwb.pyの代わりにpwbを使用してください。
最新の Pywikibot stable ブランチ: .tar.gz, .zip をダウンロードしてください。
ダウンロードしたファイルを、例えば ~/pywikibot または %USERPROFILE%\pywikibot に展開してください。
あるいは、最新版を git クライアントや svn クライアントから手に入れたい場合は、Manual:Pywikibot/Gerrit をみてください。Pywikibot を使った作業や開発を行う場合は、この方法を推奨します。
その他のバージョンは https://pywikibot.toolforge.org/ から入手できます。
Pywikibot の更新
Pywikibotを最新に保ってください。新しいバージョンは随時リリースされており、以前にダウンロードした際と同じ場所から入手することができます。
もしgitやsvnを利用してPywikibotを入手したのであれば、この節は飛ばしても構いません。ただし、新しいバージョンをインストールする前に、設定ファイルとスクリプト（user-config.py、familyファイル、自作したカスタムスクリプト、ウィキで使用している現在のXMLファイルのダンプ）のバックアップをとることは重要です。
旧バージョンのある場所に、新バージョンを展開してください。ファイルは全て上書きされます。
Pywikibotの設定
Unixライク（Linux／BSD／Solaris）ならターミナルを、Windowsならコマンドプロンプト（"Windows System"／"全てのアプリケーション"の中の"アクセサリ"フォルダ／スタートメニューの中の"全てのプログラム"以下にあります）を開いて、あなたが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には数多くのウィキに対する事前設定がありますが、あなたが使用したいウィキの事前設定がないかもしれません。 あなたのウィキ用にPywikibotを設定をする方法についてはManual:Pywikibot/Use on third-party wikisをご覧ください。
その他の設定オプション
あなたのボットの挙動を変更できるように、Pywikibotには幅広い設定オプションがあります。 あなたは「user-config.py」ファイルでそれらの設定を変更することが出来ます。 あなたが使用可能なパラメーターのリストはconfig.pyをご覧ください。
プロキシの設定
Pywikibot は、ウェブとの通信に requests を使用しています。
プロキシ サーバーを使用するようにするには、環境変数 HTTP_PROXY および HTTPS_PROXY を設定してください。
詳細情報は $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
- ご使用の Pywikibot のセットアップにさらなるヘルプが必要な場合は、IRC チャンネル #pywikibot 接続 または pywikibot@ メーリング リストにお問い合わせください。