Manual:Pywikibot/インストール

From mediawiki.org
This page is a translated version of the page Manual:Pywikibot/Installation and the translation is 97% complete.
このページではPywikibotを使い始める貴方をお助けします。お手持ちのコンピューター、Toolforge、PAWS: A Web Shell (PAWS) のどれでも大丈夫です。
Gnome-system-software-installer.svg
PAWS (no text).svg

PAWS: A Web ShellはPywikibotを使い始める最も簡単な方法です。 インストールは不要で、ウェブインターフェースを使ってコマンドを送信します。

お手持ちのコンピューター
Computer n screen.svg

自分のコンピュータにPywikibotをセットアップして実行するためのマニュアルです。この過程には主に4つの手順があります。

Toolforge logo.svg

Wikimediaサーバー上のToolforgeはあなたに安定したクラウド・インフラストラクチャを提供するので、ボットを常時または計画的に実行することが出来ます。

Pythonのインストール

https://www.python.org/downloads/ からPythonをダウンロードしてインストールしましょう。

すでにPythonをインストール済みの場合には、端末でpython --versionを実行することにより、pywikibotの動作に必要なバージョンがインストールされているかどうかを確認することができます。 To discover if Python version 3 or above is installed, run python3 --version in a console.

Ubuntu 19.04 and up comes with versions 2 & 3 installed. Python v2 runs by default using terminal command python; to use v3, use terminal command python3.

Python 3.5.3 以降 がインストールされている場合は、pywikibotの動作には十分です。

Windowsでは、Pythonやpipが正しく動作するように、環境変数PATHを変更することを忘れないようにしましょう。

依存関係のインストール

Pywikibotを利用するためには、 requests という追加のパッケージが必要です。pipを使用してインストールすることができます。pip は、Python 2.7.9以上、もしくはPython 3.4以上を使っているのであれば、デフォルトでインストールされています。requests パッケージをインストールするには、以下のコマンドを実行します。

$ pip install "requests>=2.20.1"

In addition a MediaWiki markup parser is required.[1] Please install (at least) one of them:[1]

$ pip install "mwparserfromhell>=0.5.0"

or[1]

$ pip install "wikitextparser>=0.47.5"

or both.

Pywikibot のインストール

$ pip install pywikibot
警告 警告: The last version of the zip-file is currently ((2022-07-14)) broken, it contains __metadata__.py instead of version string.

最新の Pywikibot stable ブランチ: .tar.gz, .zip をダウンロードしてください。

Python 2.7 users should download the stable python2 branch: .tar.gz, .zip instead.

ダウンロードしたファイルを、例えば ~/pywikibot または C:\Users\username\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 "\Users\username\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]

スクリプトの一覧はManual:Pywikibot/スクリプト から入手できます。

その他の依存関係

ほとんどのスクリプトには動作に追加パッケージは不要ですが、いくつかは動かない物があります。 それらは依存パッケージと共に requirements.txt でリストされています。

依存パッケージをインストールするには、$pipを使用し、以下のコマンドを実行しましょう。

$ pip install [name of the package]

もしくは全ての推奨パッケージを一度にインストールするために以下のコマンドを実行しましょう。

$ pip install -r requirements.txt


ご使用の Pywikibot のセットアップにさらなるヘルプが必要な場合は、IRC チャンネル #pywikibot 接続 または pywikibot@ メーリング リストにお問い合わせください。