EarwigBot

ソフトウェアのスクリーンショット:
EarwigBot
ソフトウェアの詳細:
バージョン: 0.1
日付のアップロード: 20 Feb 15
開発者: Ben Kurtovic
ライセンス: 無料
人気: 4

Rating: 5.0/5 (Total Votes: 1)

EarwigBotはウィキペディアを編集し、IRCの人々と対話するPythonのロボットである このファイルには、ボットをインストールしてセットアップする方法の基本的な概要を提供します。より詳細な情報は、ドキュメント/ディレクトリ(PyPIのオンラインで利用可能な)に位置しています。
の歴史
開発が始まった、Pywikipediaフレームワークに基づいて、その拳タスクの初期の2009年承認、著作権違反の検出器では、5月に行った、とボットは(月/ 2011年2月を除く)一貫して以来実行されている。それは、現在、ウィキプロジェクトテンプレートタグ付けなど、いくつかの継続的な統計の生成からカテゴリのクリーンアップに至るまで、タスク、およびオンデマンドタスクを処理します。それが実行して開始して以来、ボットは50,000以上の編集を行っている。
スクラッチからそれを書き換えるプロジェクトがPywikipediaフレームワークから離れると少なく全体的なコード、ボットの部品間のより良い統合、および容易にメンテナンスを可能にし、したがって、初期の2011年4月に始まった。
<強い>インストールの
このパッケージは、MediaWikiのサイト上でボットを実行している誰もが使用できる、カスタマイズ可能でなければならないことを十分に抽象化コアearwigbotが、含まれています。それはコンポーネントベースであるため、必要に応じて、IRCコンポーネントを無効にすることができます。私が必要とする平均的なユーザーを感じることはありませんEarwigBotの私のインスタンスに固有のIRCコマンドとボットの作業は、リポジトリearwigbot-プラグインから利用できます。
これは、インストールする前に、ボットのユニットテストを実行することをお勧めします。プロジェクトのルートディレクトリからのpython setup.pyテストを実行します。いくつかのテストは、インターネット接続を必要とし、他の人が実行にしばらく時間がかかる場合があります。カバレッジは現在、むしろ不完全です。
のセットアップ
ボットは、その設定ファイルやデータベースなどの「作業ディレクトリ」でそのデータが格納されます。これはまた、後述するカスタムIRCコマンドとボット作業を、格納される場所です。このディレクトリは限りボットがそれに書き込むことができますように、ここでは関係ありません。
earwigbotパスを持つボットを開始/ /作業/ DIR、または作業ディレクトリがカレントディレクトリである場合だけearwigbotへ。それはcon​​fig.ymlファイルが存在しないことに気づくとセットアッププロセスを通じて行くことができます。
そこには、作成された後のボット内からconfig.ymlファイルを編集する方法は現在のところありませんが、あなたが必要な変更を自分で作ることができるはずですので、YAMLは、非常に単純な形式です。助けをWikipediaでYAMLの説明をご覧ください。
セットアップ後は、ボットが開始されます。これは、特定の時間に実行するようにスケジュールボットタスク、それが設定されているIRCサーバに接続し、(IRC上のコマンドなど)の指示を待つことを意味します。コマンドのリストについては、「!ヘルプ」(コマンドは感嘆符で始まるメッセージである)と言う。
あなたは、通常のPythonプログラムを停止と同じコントロール+ C、といつでもボットを停止することができ、それが安全に終了しようとします。また、IRCの「!QUIT "コマンドを使用することができます。
カスタマイズの
ボットの作業ディレクトリには、コマンドのサブディレクトリとタスクサブディレクトリが含まれています。カスタムwikiのボットタスクは後者に入るのに対し、カスタムIRCコマンドは、前者に配置することができます。カスタムモジュールの開発は、PyPIの上のボットのドキュメントを通じて(またはドキュメント/ dirの中で)以下に説明すると、より詳細にされている。
カスタムコマンドは、同じ名前の組み込みコマンドとタスクを上書きすることに注意してください。
ボットとBotConfig
earwigbot.bot.BotはEarwigBotのメインクラスです。あなたはこの自分自身をインスタンス化する必要はありませんが、それはボットの他の部分と通信するための主な方法ですので、それは、その属性とメソッドに精通していることが良いことだ。ボットオブジェクトは、コマンドとタスクの属性(すなわち、self.bot)としてアクセス可能です。
earwigbot.config.BotConfigはボットの構成情報を格納します。そのドキュメント文字列は、各属性が使用されますが、基本的にそれぞれの「ノード」(config.components、ウィキ、IRC、コマンド、タスクの1、およびメタデータ)は、ボットのconfig.ymlファイルのセクションにマップについて説明します。たとえば、config.ymlのようなものが含まれている場合:
IRC:
&NBSP;フロントエンド:
&NBSP;ニック:MyAwesomeBot
&NBSP;チャネル:
&NBSP; - 「## earwigbot」
&NBSP; - "#channel」
&NBSP; - "#他のチャンネル」
...その後config.irc ["フロントエンド"] ["ニックは"] "MyAwesomeBot」とconfig.irc ["フロントエンド "] ["チャンネル "]となります" ## earwigbot "、" #channel "[なり、 「#他のチャンネル "]。
カスタムIRCコマンド
カスタムコマンドは、コマンドのプロセス()(および必要に応じてチェック()またはセットアップ())メソッドをオーバーライドearwigbot.commands.Commandのサブクラスです。
ボットは、組み込みコマンドとサンプルコードとして機能するように、および/またはアイデアを与えるために、プラグインの幅広い選択をしています。テストで起動し、いくつかのより複雑なスクリプトのchanopsとafc_statusをチェックしてください。
カスタムボットタスク
カスタムタスクは、タスクの実行()(および必要に応じてセットアップ())メソッドをオーバーライドearwigbot.tasks.Taskのサブクラスです。
比較的簡単なタスクのための組み込みのwikiproject_taggerタスク、またはより複雑な1のためのafc_statisticsプラグインを参照してください。
<強い>ウィキツールセット

PywikipediaフレームワークのEarwigBotの答えはあなたが主にbot.wikiを介してアクセスしますウィキツールセット(earwigbot.wiki)、である。
bot.wikiはサイトの管理のための三つの方法を提供 - get_site()、add_site()、およびremove_site()。サイトは、単にMediaWikiのサイトを表すオブジェクトです。 EarwigBot(すなわち、単一の作業ディレクトリ)の単一のインスタンスは、(CentralAuthを持つすべてのWMFのwikiのように)同じログイン情報を使用してサイトの単一のサイトまたはグループに関連することが期待される。
あなたのデフォルトサイトサイト= bot.wiki.get_siteで(セットアップ時に選んだ1)をロード()。
ツールセットのすべての側面は、ドキュメントでカバーされているわけではありません。より実践的な方法でそれを使用する方法を学ぶために、そのコードとドキュメンテーション文字列を探る。参考までに、bot.wikiはボットの作業ディレクトリ内sites.dbファイルに結び付けearwigbot.wiki.SitesDBのインスタンスである。

の要件の:ます。

  • のPythonます。

同じようなソフトウェア

へのコメント EarwigBot

コメントが見つかりません
コメントを追加
画像をオンにする!