Manual:Pywikibot/Compat/基礎的な使用
 | This page is documentation for Pywikipedia Compat, which is no longer supported. このページは歴史的な興味のため保持されています。 It may document scripts and features that are obsolete and/or no longer supported. Do not rely on the information here being up-to-date. |
使用
- Windowsユーザーの方は、ショートカットを作るをご覧ください。
ボット スクリプトの選択と実行
これでPythonとPywikibotのインストールができたので、あなたのオペレーティングシステムのテキスト・インターフェースにアクセスしましょう。
- pywikibot へのアクセス
user-config.pyという名前のファイルを作成した後、pywikibotにアクセスすることができます。
Windowsではスタートメニューを開いて、「ファイル名を指定して実行」をクリックしてください。プログラムの名前を訊かれるので、cmd.exeと打ち込みましょう。
chdir C:\を打ち込むことで、ルートをC:に変更しましょう
- 「chdir \"pywikibotがダウンロードされた場所"」と入力してください。(例えばファイルが C: フォルダーにある場合は、「chdir \"pywikibot"」と入力しましょう。)
以下の作業が必要になるかもしれません。
externalsのサブフォルダに入っているhttplib2フォルダを一階層上に移動させましょう。
- 実行したいすべてのスクリプトはscriptsサブフォルダからメインフォルダに移動する必要があります。login.pyも含まれます。
Macでは、/Applications/UtilitiesからTerminal.appを探して、Macでのインストールを御覧ください。
Linuxや他のUnixでは、gnome-terminalやkonsole、xtermなど、好きなターミナルを使用してください。テキストモードのコンソールでもいいです。
Compatでは、login.pyスクリプトをpython login.pyと入力して実行しましょう。user-config.pyをまだ持っていなければ、このコマンドで対話的に作成することができます。
coreでは、coreのディレクトリにおいて、login.pyスクリプトをpython login.pyと入力して実行しましょう。user-config.pyをまだ持っていなければ、このコマンドで対話的に作成することができます。
- パスワードの入力
するとPythonは次のように返してきます。
Password for user your_bot on your_site:en:
Botのログイン名に使ったパスワードを使用してください。あなたの入力はプライバシー保護のため見えなくなっていることに注意してください。Botを匿名で活動させることはできません。Botは普通ログオフ状態にならないので、パスワードを変更しない限り、このプログラムはたいてい1回の実行で十分です。
- ボットの使用
Botはダウンロードした時のpywikibotのメインフォルダに入っています。
もし必要であれば、cdコマンドを使用してbotファイルが保存されているディレクトリに移動してください。
それではpython botname.py (Windowsを使用しているなら、pythonは省いてください) と入力してbotを実行しましょう。
スクリプト
- メインのページ: Manual:Pywikibot/スクリプト
コマンドライン引数
多くのbotスクリプトは固有のコマンドライン引数を持っており、それについてはスクリプトのページやソースファイルの中に説明があるはずです。すべてのbotは、特に否定されていない限り、以下のコマンドライン引数も受け付けます。
(完全なリストはここにあります: &1)
- -help
- グローバルなbot引数(このリスト)と、利用可能ならその下にbot特有のヘルプを表示します。
- -lang:xx
- 言語コード
xxにあなたが作業したいウィキの言語を設定します。user-config.py内の設定を上書きします。 - -family:xyz
- wikipedia, wiktionary, wikitravelといった、あなたが実行したいウィキのファミリーを設定します。
user-config.py内の設定を上書きします。 - -user:xyz
- デフォルトの利用者名ではなく、利用者'xyz'としてログインします。
- -log
- ログファイルを有効にします。ログは'logs'サブフォルダに保存されます。
- -log:xyz
- ログファイルを有効にします。ファイル名は
xyzになります。 - -nolog
- ログファイルを無効化します(もしデフォルトで有効にされていれば)。
- -putthrottle:nn
- botが編集間に待機する最低時間(単位：秒)を定義します。デフォルトの値は10秒です。
例えば、python scriptname.py -family:wiktionary という実行文は「scriptname」という名前のボットをウィクショナリーの記事に対して実行します。あなたの既定ののプロジェクト設定は無視されます。
ウィキメディアのプロジェクトにおける実行権限
botを使用しようと考えているウィキのコミュニティからあなたのbotについて承認を受けなければいけません。指針としてグローバルなbotの方針を御覧ください。プロジェクト間で方針の厳格さは大きく異なります。
あなたのいつものブラウザを使って、bot用の利用者名とパスワードを作りましょう。利用者名は、botであることがはっきりしていて、更に言えば誰が動かしているのかをわかるものであるのが望ましいです。よく使われる方法は、あなたの利用者名に'bot'と加えることですが、他の方法もいくつか存在しています。