Help:Pywikipediabot/Mac

これはpywikipediaをあなたのMacで動作させるための手順ごとのガイドです(オリジナルのガイドよりかんたんで読みやすくなってればよいのですが)。

ダウンロード[編集]

MacPythonをダウンロードする[編集]

どのMac OS Xにも、Pythonはデフォルトでインストールされていますので、Pythonをインストールする必要はありませんが、アップデートが必要になるかもしれません。ここにその方法を示します。

最初に、Pythonをダウンロードする必要があります。MacPythonをダウンロードするときは、"Python 2.5.2 for Macintosh OS X”を選んでください。ダウンロードしたdmgファイルを開き、インストールを行ってください。FinderでApplicationsフォルダに“MacPython 2.5”というフォルダがあればインストールは完了です。

注意: あなたのMacに"IDLE"という新しいアプリケーションがインストールされますが、ここでの目的には関わらないアプリケーションです。

SVNをダウンロードする[編集]

多くのウィキメディアプロジェクトでは、botを動かすにあたり、Pywikipediaフレームワークの最新のバージョンを要求しています。これはSVNを使うことで簡単に実現できます。これはbotを走らせるよりも簡単です。

もしOSが10.5もしくはそれ以前のものを使っているなら、"My Subversion-1.5.5 Package"をこのページからダウンロードする必要があります。Subversion-1.5.5パッケージを開き、インストールを完了しましょう。これでスクリプトをダウンロードする準備ができました。

スクリプトをダウンロードする[編集]

Terminalを開きましょう(Spotlightで検索なさるとよいでしょう)。次の文章をTerminalにコピーし、エンターもしくはリターンを押してください。:

svn checkout http://svn.wikimedia.org/svnroot/pywikipedia/trunk/pywikipedia/ pywikipedia

“home”(Finderの左の枠のなかにある、家のアイコンとあなたのユーザ名の部分をクリックしてください)フォルダに“pywikipedia”という名前で新しいフォルダが作られているはずです。ダウンロードが終了すると、すべてのスクリプトがそこにあるはずです。 端末の最後の行がつぎのものになると、ダウンロードは終了です。

NAME_OF_COMPUTER:~ USER_NAME$

この文章はあなたがTerminalを開いたときと同じものです(これは「プロンプト」と呼ばれます)。

設定する[編集]

botを使うためには、設定をする必要があります。シンプルかつ信頼できるTUIであるpicoを使って設定をしましょう。

端末を開き、pywikipediaのフォルダへディレクトリを移動させてください。例えば次のように:

cd pywikipedia

そして、pico user-config.pyと入力してください。 CTRL-Oを押すとファイルがディスクに書き込まれ、CTRL-Xを押せばエディタを終了できます。

言語[編集]

mylang = 'xx'

“xx” はあなたが主にbotを動かす言語です。Wikimediaプロジェクトの言語コードとおなじです。

プロジェクト[編集]

もし主にWikipediaでbotを動かしたいなら、そのまま次の節に進んで結構です。Wikibooksで動かしたいのなら、user-config.pyに次の行を加えてください:

family = 'wikibooks'

注意: Wiktionaryでbotを動かすのは、ほかのプロジェクトのそれよりだいぶ面倒です。ですから、初心者にはお勧めできません。 また、もしbotをコモンズで動かしたいのなら、mylangfamilyの両方に"Commons"と書いてください。

利用者名[編集]

使いたい利用者名を決めてください。まだwikiにはログインしないでください。これを使うことでそれを行うことができます:

usernames['FAMILY']['MYLANG'] = u'ExampleBot'

“MYLANG”は上記のmylangで定義したものと同じものです。"FAMILY"も同様です。ただし、Wikipediaでbotを動かすばあい、familyにはなにも定義されていないはずですが、ここには記述する必要があります(サンプルが以下にあります)。それぞれのウィキメディアのウィキで動かすボットについて、望むだけ利用者名を設定をすることができます(ひとつのウィキについて設定はひとつまでです)。インターウィキ以外のものは、デフォルトはmylangについて設定したものになります。botはuser-config.pyで定義されたすべてのwikiで動作します。

文字エンコード[編集]

UTF-8 を使用したいときはこれを使用します。特別にASCIIで定義されていない文字を利用者名に使うだとかいった場合はこれが重要です。もし変更しなければ、"?"を多数の場所でみることになるでしょう。たとえば、スペイン語の名前であるMarìa は Mar?a のようになります。なので、user-config.pyに次の行を加えてください:

console_encoding = 'utf-8'

APIでログインする[編集]

SUL上の問題から、botはAPIを通じてログインをする必要があります。そのため、user-config.pyに次の行を加えてください:

use_api_login = True

これを"pywikipedia"に保存して、TextEditを閉じてください。

user-config.py の設定の例[編集]

ノルウェー語版wikipediaにEksempelBotという利用者名でbotを動かすとき[編集]

mylang = 'no'
usernames['wikipedia']['no'] = u'EksempelBot'

console_encoding = 'utf-8'
use_api_login = True

CommonsにExampleBotという利用者名でbotを動かすとき[編集]

mylang = 'commons'
family = 'commons'
usernames['commons']['commons'] = u'ExampleBot'

console_encoding = 'utf-8'
use_api_login = True

ドイツ語版WikipediaとWikibooksにBeispielBotという利用者名でbotを動かすとき[編集]

mylang = 'de'
usernames['wikipedia']['de'] = u'BeispielBot'
usernames['wikibooks']['de'] = u'BeispielBot'

console_encoding = 'utf-8'
use_api_login = True

必要なウィキに利用者名を登録する[編集]

bot を動かしたいwikiに登録をすることをおすすめします。それなら、あなたの所有するアカウントでログインするときには、検索ボックスに “Special:Userlogin”と打ち込んで、登録するアカウントを選んでください。入力窓に求められた情報を入力し、アカウントを作成しましょう。 アカウントの作成が成功したのなら、botを動かすことができます。

SULを使うことで簡単にいくつかのwikiでbotを動かすことができます。最近botアカウントを作ったのであれば、すでに統合されているはずです。

少し前にアカウントを作成していた、もしくは少し前に他のwikiでアカウントを作成していたのであれば、統合されていないはずです。 その場合、Special:MergeAccountでアカウントの統合をする必要があります。

Botフラグとテスト運用[編集]

Botを動かす[編集]

正しいフォルダに進む[編集]

スクリプトを動かすためには、最初にスクリプトがあるフォルダへ進む必要があります。端末に次の文字列を入力してください。:

cd /Users/USER_NAME/pywikipedia

“USER_NAME” はFinderの家のアイコンの右にあるhomeのテキストから分ります。

Tip[編集]

毎回上記のように書くのは非生産的と思われるかもしれません。Terminalはあなたの使ったコマンドを保存しており、キーボードの上矢印キーを押すことで再利用できます。上矢印キーを一回押せば最後に使ったコマンドを見ることができます。出てきたコマンドは間違っているかもしれません。その時は正しいものが出てくるまでキーを押し続けてください。そしてenter/returnを押せば、botの作業を始めることができます。

ログイン[編集]

あなたはwikiにbotアカウントでログインする必要があります。そのときはTerminalにつぎのように入力してください:

python login.py

端末はパスワードを尋ねてくるはずです。そうしたら、botアカウントで使用するパスワードを入力してください。

いくつものwikiにログインしたいのであれば

login.py -all

と書き、上と同じようにパスワードを入力してください。

特にログアウトなどの行動を取らない限り、botはログアウトされることはありませんから、再ログインをする必要はないでしょう。

スクリプトを動かす[編集]

正しいフォルダに移動したあと、次の文字列を入力することで、スクリプトを動作させることができます:

python SCRIPT_NAME.py

スクリプトの一覧は、ここ[1]を見てください。

引数[編集]

引数は - と共に入力する必要があります。: -pt:15のように - の後ろに引数名をつけてください。多くのスクリプトは引数を必要とします。interwiki.pyの例を示します:

python interwiki.py -start:! -autonomous

デフォルトでは、botはウィキ間リンクをあなたのメイン言語/プロジェクトで作成します。またそれを登録されているすべてのwikiで校正します。-start と -autonomous はwikiですべてのページをチェックし、ウィキ間リンクを作成/訂正するよう指定します。これは何も除去しませんし、衝突が発生したときには停止してしまいます。詳しいことはinterwiki.pyを見てください。

グローバル引数[編集]

すべてのスクリプトで使用可能な引数については、Help:Pywikipediabot/Global_Optionsを参照してください。

メンテナンス[編集]

アップデート[編集]

スクリプトをアップデートするときは、つぎの文字列をTerminalに入力します:

svn update pywikipedia

終了したら、“At revision XXXX” (“XXXX” は最新のバージョン番号)と返されるはずです。もしmodified いくつかのスクリプトを変更していても、心配する必要はありません。あなたが行った変更はアップデートされたものに統合されます。

Automatorの使い方をご存じでしたら、ワークフローを書いてシェル処理をアプリケーションにすることができるでしょう。それをデスクトップやDockに保存すると、アップデート作業が簡単になります。左クリックをしてメニューを開き、altキーを押しながら、「常にこのアプリケーションで開く」のなかの「Automator runner」を選ぶのもよい案でしょう。

変更する[編集]

言語ごとに指定されている要約欄へ挿入する文章など、スクリプトのテキストを書き換えたくなるかもしれません。その場合、右クリックをして、カーソルを「このアプリケーションで開く」にあわせ、そして「その他…」を選び下にスクロールしてTextEditをダブルクリックしてください。しかし、これは義務ではないし、初心者にはお勧めできないことです。それでもやるならば、スクリプトの編集には十分気をつけてください、と言っておきます。

元に戻す[編集]

スクリプトに行った変更を元に戻したいときは、次の文字列を入力するだけです:

svn revert NAME_OF_SCRIPT.py

botが突然動かなくなり、 SyntaxError: invalid syntaxという文章が返されたら、それはSVNのアップデートと衝突したということです。

問題のファイルを上のように巻き戻してください。それでうまく動くようであれば、次に下のものをTerminalで動かしてください:

svn resolved NAME_OF_SCRIPT.py

そのあと、またスクリプトの変更をやってみてください。

脚注[編集]

  1. ^ meta(英語)により詳細な一覧があります。