EarwigBot

.

EarwigBot는 위키 백과를 편집하고 IRC를 통해 사람들과 상호 작용 & NBSP 파이썬 로봇이다이 파일은 봇을 설치하고 설정하는 방법에 대한 기본 개요를 제공합니다; 더 자세한 정보는 문서 / 디렉토리 (PyPI에서 온라인)에 위치하고 있습니다.
역사
개발이 주먹 태스크, 저작권 침해 감지기 2009 년초 승인에 Pywikipedia 프레임 워크를 기반으로, 시작 월에서 수행하고, 봇 (월 / 2011년 2월 제외) 이후 일관 적 실행되었다. 그것은 현재와 같은 WikiProject 템플릿 태그 등 여러 가지 지속적인 통계 세대 카테고리 정리에 이르기까지 다양한 작업 및 주문형 작업을 처리합니다. 이 실행을 시작하기 때문에, 봇 50,000 편집을 통해했다.
처음부터 다시 작성하는 프로젝트는 이렇게 멀리 Pywikipedia 프레임 워크에서 이동 덜 전체 코드, 로봇 부품 사이의 더 나은 통합, 쉬운 유지 보수를 위해 수 초 2011 년 4 월 시작했다.
설치
이 패키지는 미디어 위키 사이트에서 로봇을 실행하는 누구나 가능하고 사용자 정의해야 충분히 추상화 핵심 earwigbot가 포함되어 있습니다. 이 컴포넌트 기반이므로 필요하다면, IRC 컴포넌트가 행해지 지 않도록 할 수있다. 내가 필요한 일반 사용자를 느끼지 않는다 EarwigBot 내 인스턴스에 특정 IRC 명령과 로봇의 작업은 저장소 earwigbot - 플러그인에서 사용할 수 있습니다.
그것은 설치하기 전에 봇의 단위 테스트를 실행하는 데 좋습니다. 프로젝트의 루트 디렉토리에서 파이썬 setup.py 테스트를 실행합니다. 몇 가지 테스트가 인터넷 연결을 필요로하며, 다른 사람들이 실행하는 데 시간이 걸릴 수도 있습니다. 범위는 현재 오히려 불완전합니다.
설정
봇은 설정 파일과 데이터베이스를 포함하여 "작업 디렉토리"에 데이터를 저장합니다. 이것은 또한 사용자 정의 IRC 명령과 후술 봇 작업을 배치 할 위치입니다. 이 디렉토리가 한 로봇이 쓸 수있는, 어디 그것은 중요하지 않습니다.
earwigbot 경로 봇 / 시작 / 작업 / DIR, 또는 작업 디렉토리가 현재 디렉토리의 경우 단지 earwigbot에. 그것은 더 config.yml 파일이 존재하지 않음을 감지하고 설치 프로세스를 안내합니다.
이 그것이 생성 된 후에 봇 내에서 config.yml 파일을 편집 할 수있는 방법은 없습니다,하지만 당신은 필요에 따라 변경 자신을 만들 수 있어야하므로 YAML은 매우 간단 형식입니다. 도움 위키 백과에 YAML의 설명을 확인하십시오.
설치 후, 봇이 시작됩니다. 이것은 (IRC의 명령으로)이 특정 시간에 실행되도록 스케줄 봇 작업에 대해 구성된 IRC 서버에 연결 한 다음 지시를 기다릴 것을 의미합니다. 명령 목록은 "! 도움말을"(명령은 느낌표로 시작 메시지입니다) 말한다.
당신은 보통 파이썬 프로그램을 중지 같이 동일한 컨트롤 + C, 언제든지 로봇을 중지 할 수 있으며 안전하게 종료하려고합니다. 또한 IRC에! "종료"명령을 사용할 수 있습니다.
사용자 정의
로봇의 작업 디렉토리는 명령 하위 디렉토리 및 작업 하위 디렉토리가 포함되어 있습니다. 사용자 지정 위키 봇 작업 후자로 이동하는 반면 사용자 정의 IRC 명령은, 이전에 배치 할 수 있습니다. PyPI에 봇의 문서를 통해 아래에 설명하고,보다 상세하게 사용자 정의 모듈을 개발한다 (또는 문서 / DIR에서).
사용자 정의 명령은 같은 이름의 내장 명령과 작업을 우선합니다합니다.
봇과 BotConfig
earwigbot.bot.Bot는 EarwigBot의 주요 클래스입니다. 당신이 직접 인스턴스화 할 필요는 없지만,이 로봇의 다른 부분과 통신 할 수있는 주요 방법이 있기 때문에, 그것의 속성과 방법을 잘 알고 있어야 좋다. 봇 객체는 명령 및 작업 (즉, self.bot)의 속성으로 액세스 할 수 있습니다.
봇 earwigbot.config.BotConfig 구성 정보를 저장합니다. 그 문서화 문자열은 각 속성에 대해 사용되지만, 실질적으로 각각 "노드"(config.components 위키, IRC, 명령, 작업 중 하나, 및 메타 데이터)가 로봇의 config.yml 파일의 부분으로 매핑 대해 설명. 예를 들어, config.yml 같은 것을 포함한다 :
IRC :
& NBSP; 프론트 엔드 :
& NBSP; 아이디 : MyAwesomeBot
& NBSP; 채널 :
& NBSP; - "## earwigbot"
& NBSP; - "#channel"
& NBSP; - "# 다른 채널"
... 다음 config.irc [ "프론트 엔드"] [ "닉은"] "MyAwesomeBot"과 config.irc [ "프론트 엔드"] [ "채널"] 할 예정 [ "##의 earwigbot", "#channel"입니다, "# 다른 채널"].
사용자 정의 IRC 명령
사용자 정의 명령은 명령의 프로세스 () (선택적 검사 () 또는 설정 ()) 메소드를 오버라이드 (override) earwigbot.commands.Command의 하위 클래스입니다.
봇 샘플 코드로 작동하도록 및 / 또는 아이디어를 제공하기 위해 내장 명령 및 플러그인의 다양한 종류가 있습니다. 테스트 시작하고 좀 더 복잡한 스크립트 chanops 및 afc_status를 확인하십시오.
사용자 정의 봇 작업
사용자 정의 작업은 작업의 실행 () (및 옵션 설정 ()) 메소드를 오버라이드 (override) earwigbot.tasks.Task의 하위 클래스입니다.
비교적 간단한 작업을 위해 내장 된 wikiproject_tagger 작업을 참조하거나 afc_statistics는 더 복잡 하나 플러그인.
위키 툴셋
Pywikipedia 프레임 워크 EarwigBot의 대답은 당신이 주로 bot.wiki를 통해 액세스 할 위키 도구 집합 (earwigbot.wiki)입니다.
bot.wiki 세 사이트의 관리를위한 방법 제공 - get_site (), add_site () 및 remove_site을 (). 사이트는 단순히 미디어 위키 사이트를 나타내는 개체입니다. EarwigBot의 단일 인스턴스 (즉, 하나의 작업 디렉토리) 단일 사이트 또는 (CentralAuth 모든 WMF 위키 등) 같은 로그인 정보를 사용하는 사이트의 그룹에 관련된 것으로 예상된다.
기본 사이트 사이트 = bot.wiki.get_site와 (설치 중에 고른를)로드 ().
도구 모음의 모든 측면이 문서에 포함되지는 않습니다. 보다 실제적인 방식을 사용하는 방법에 대한 자세한 내용은 해당 코드 및 문서화 문자열을 탐험 해보세요. 참고로, bot.wiki는 earwigbot.wiki.SitesDB의 인스턴스가 로봇의 작업 디렉토리에 sites.db 파일에 묶여있다

이 요구 사항 : 있습니다.

파이썬