EarwigBot הוא רובוט Python שעורך ויקיפדיה ואינטראקציה עם אנשים מעל IRC & nbsp;. קובץ זה מספק סקירה בסיסית של איך להתקין ולהגדיר את בוט; מידע מפורט יותר נמצא במסמכים / הספרייה (זמין באינטרנט בPyPI).
ההיסטוריה
פיתוח החל, המבוסס על מסגרת Pywikipedia, בשנת 2009. אישור מוקדם למשימה האגרוף שלה, גלאי הפרת זכויות יוצרים, בוצע בחודש מאי, ובוט כבר פועל באופן עקבי מאז (למעט ינואר / פברואר 2011). בשלב זה מטפל במספר משימות שוטפות הנעות בין דור סטטיסטיקה לניקוי קטגוריה, ומשימות על פי דרישה כגון תיוג תבנית WikiProject. מאז זה התחיל לרוץ, בוט עשה מעל 50,000 עריכות.
פרויקט לשכתב אותו מאפס החל בתחילת אפריל 2011, ובכך מתרחק ממסגרת Pywikipedia ומאפשר פחות קוד כללי, אינטגרציה טובה יותר בין חלקי בוט, ותחזוקה קלה יותר.
התקנה
חבילה זו כוללת את earwigbot הליבה, מפוזר מספיק שזה צריך להיות שמיש והתאמה אישית על ידי כל מי שפועל עם רובוט באתר ויקי. מאז הוא מבוסס רכיבים, יכולים להיות נכה רכיבי IRC אם תרצה בכך. פקודות IRC ומשימות בוט ספציפיות למופע של EarwigBot שאני לא מרגיש את המשתמש הממוצע יצטרך זמינות מearwigbot-תוספי מאגר.
מומלץ להפעיל בדיקות היחידה של בוט לפני ההתקנה. הפעלה של בדיקת setup.py פיתון מספריית השורש של הפרויקט. שימו לב שכמה בדיקות דורשות חיבור לאינטרנט, ואחרים עשויים לקחת זמן לרוץ. הכיסוי הוא כיום ולא שלם.
הגדרות
בוט מאחסן את הנתונים ב" ספריית עבודה ", כולל הקבצים ומסדי נתוני config. זהו גם המקום שבו תוכל למקם פקודות IRC המותאם אישית ומשימות בוט, שתוסברנה בהמשך. זה לא משנה איפה בספרייה זו היא, כל עוד בוט יכול לכתוב את זה.
התחל בוט עם נתיב earwigbot / ל/ עבודה / dir, או סתם earwigbot אם את ספריית העבודה היא הספרייה הנוכחית. זה יבחין כי אין קובץ config.yml קיים ולקחת אותך בתהליך ההתקנה.
אין כרגע אפשרות לערוך את קובץ config.yml מתוך בוט לאחר שנוצר, אבל YAML הוא פורמט מאוד פשוט, אז אתה אמור להיות מסוגל לעשות את כל שינויים דרושים בעצמך. בדוק את ההסבר של YAML על ויקיפדיה לעזרה.
לאחר התקנה, בוט יתחיל. זה אומר שזה יהיה להתחבר לשרתי IRC זה כבר מוגדר עבור, משימות בוט לוח זמנים להפעלה בזמנים מסוימים, ולאחר מכן להמתין להוראות (כפקודות על IRC). לקבלת רשימה של פקודות, אומר "עזרה!" (פקודות הן הודעות התחילית סימן קריאה).
אתה יכול לעצור את בוט בכל עת עם Control + C, בדיוק כמו שאתה לעצור תכנית פייתון נורמלית, והוא ינסה לצאת בשלום. ניתן גם להשתמש בפקודה "! להתפטר" ב- IRC.
התאמה אישית
ספריית העבודה של בוט מכילה ספריית משנה פקודות וספריית משנת משימות. ניתן להציב פקודות IRC המותאם אישית בעבר, ואילו משימות בוט wiki מותאמות אישית להיכנס לזה האחרון. פיתוח מודולים מותאמים אישית מוסבר להלן, ובפירוט רב יותר באמצעות התיעוד של הרובוט בPyPI (או במסמכים / dir).
שים לב שפקודות מותאמות אישית תעקוף פקודות ומשימות מובנים בעל אותו שם.
Bot וBotConfig
earwigbot.bot.Bot הוא המעמד המרכזי של EarwigBot. אתה לא צריך להפעלת זו בעצמך, אבל זה טוב להיות מוכר עם התכונות והשיטות שלה, כי זה הוא הדרך העיקרית כדי לתקשר עם חלקים אחרים של בוט. אובייקט Bot נגיש כתכונה של פקודות ומשימות (כלומר, self.bot).
מידע תצורת חנויות earwigbot.config.BotConfig לבוט. docstring מסביר מה כל תכונה זו משמשת ל, אבל במהות כל "צומת" (אחד מconfig.components, wiki, irc, פקודות, משימות, ומטה) מפות לסעיף של קובץ 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 המובנה למשימה פשוטה יחסית, או afc_statistics תוסף לאחד יותר מסובך.
Wiki כלי הכלים
תשובתו של EarwigBot למסגרת Pywikipedia היא (earwigbot.wiki) Toolset Wiki, שבו אתה יהיה בעיקר לגשת דרך bot.wiki.
bot.wiki מספק שלוש שיטות לניהול אתרים - get_site (), add_site (), וremove_site (). אתרים הם אובייקטים שפשוט מייצגים אתר ויקי. מופע יחיד של EarwigBot (כלומר ספריית עבודה אחת) צפוי להתייחס לאתר יחיד או קבוצה של אתרים תוך שימוש באותה פרטי התחברות (כמו כל אתרי הוויקי WMF עם centralauth).
לטעון אתר ברירת המחדל שלך (אחד שאתה הרים במהלך התקנה) עם האתר = bot.wiki.get_site ().
לא כל ההיבטים של הכלים מכוסים במסמכים. חקור את הקוד וdocstrings כדי ללמוד כיצד להשתמש בו בצורה יותר על ידיים. להתייחסות, bot.wiki הוא מופע של earwigbot.wiki.SitesDB קשור לקובץ sites.db בספריית העבודה של בוט
דרישות :.
- Python
תגובות לא נמצא