메뉴얼:Pywikibot/설치
이 문서의 이하의 내용에서는 여러분의 컴퓨터에 직접 Pywikibot를 설치하고 작동시키는 법에 대해 적혀있습니다. 이 설치법은 크게 보았을 때 총 네 번의 단계로 구분됩니다.
파이썬 설치하기
https://www.python.org/downloads/ 에서 파이썬을 내려받아 설치하세요.
Make absolutely certain that you check the box at the bottom of the install wizard asking if you want to add Python to PATH!
That will allow you to access Python from any command prompt just by typing the keyword python.
만일 이미 파이썬이 설치되어 있다면, python --version 명령어 등을 이용하여 여러분이 사용 중인 파이썬 버전을 확인해 보세요.
To discover if Python version 3 or above is installed, run python3 --version in a console.
Ubuntu 19.04 and up comes with versions 2 & 3 installed.
Python v2 runs by default using terminal command python; to use v3, use terminal command python3.
봇을 가동하려면 파이썬 3.7 이상 이 필요하며, 파이썬 3.8 이상이 권장됩니다. Windows의 경우 파이썬과 pip가 올바르게 동작하기 위해 PATH 환경변수를 설정하는 것을 잊지 마세요.
기타 필요물 설치하기
Additional packages are required to run Pywikibot. Run the following command to install these packages:
$ python -m pip install "requests>=2.20.1"
$ python -m pip install "mwparserfromhell>=0.5.2"
$ python -m pip install packaging
For Python 3.7 an additional package is required. Install it with:
$ python -m pip install importlib_metadata
An alternate MediaWiki markup parser may be installed with:
$ python -m pip install "wikitextparser>=0.47.5"
See also https://doc.wikimedia.org/pywikibot/stable/introduction.html#quick-start
Pywikibot 설치하기
$ python -m pip install pywikibot
If using pip, use pwb instead of python pwb.py in examples below.
현재 Pywikibot의 stable 분기 내려받기: .tar.gz, .zip.
다운이 끝나면, 다운 받은 파일의 압축을 풉니다. 예를 들면 ~/pywikibot 또는 %USERPROFILE%\pywikibot 경로에 압축을 풀어주면 됩니다.
대안으로, Gerrit으로부터 Git 또는 SVN을 통해 최신 버전을 받을 수 있습니다. Manual:Pywikibot/Gerrit#For users을 참조하세요. 작동중인 봇 운영자 또는 개발자에게 권장됩니다.
https://pywikibot.toolforge.org/ 에서 다른 버전을 찾을 수 있습니다.
Pywikibot 업데이트
Pywikibot을 계속해서 최신 상태로 유지시켜 주십시오. 새 버전은 계속해서 나오고 있습니다.
만일 Git 또는 SVN을 통해 다운로드했다면 이 문단을 무시해도 좋습니다. 아니라면 새 버전을 설치하기 전에 설정파일과 스크립트("user-config.py", 모든 family 파일, 직접 생성하거나 변경한 스크립트, 그리고 현재 위키를 위해 사용되는 모든 XML 덤프 파일)의 백업에 유의하세요.
새 버전의 압축을 풀어 구 버전의 모든 파일을 덮어씌우세요.
Pywikibot 설정하기
Unix 계열(Linux/BSD/Solaris)에선 'Terminal'을, Windows에서는 '커맨드 창'(명령 프롬프트)를 엽니다. 그리고 여러분이 Pywikibot의 압축을 푼 폴더로 경로를 이동시킵니다. 이동을 위해선 다음과 같이 입력해야 합니다.
- Unix 계열(Linux/BSD/Solaris):
$ cd ~/core
- Windows:
$ c: $ cd "%USERPROFILE%\pywikibot"
물론 상기한 경로 외에 여러분이 원하는 다른 경로를 쓸 수도 있습니다.
그리고 다음과 같은 명령을 입력하여 사용자-설정(user-config) 파일을 생성합니다. Windows에서는 가장 앞에 있는 'python' 부분은 입력할 필요가 없습니다. 또한 .py 확장자 파일의 기본 연결프로그램 설정이 파이썬이 아닌 다른 프로그램으로 되어 있으면 제대로 동작하지 않을 수 있습니다.
$ python pwb.py generate_user_files
그 후 나타나는 글에 따라 순서대로 본인에게 맞는 설정을 입력합니다.
마지막으로 다음 명령을 입력하여 여러분이 설정한 위키에 로그인합니다. 그리고, 비밀번호를 입력하여 로그인을 완료합니다.
$ python pwb.py login
third-party 위키에서 사용하기
Pywikibot은 많은 위키에서 사전 설정돼있지만, 당신이 작업하고자 하는 위키에는 그렇지 않을 가능성이 큽니다. 당신의 위키에 Pywikibot을 설정하기 위해서는 Manual:Pywikibot/Use on third-party wikis를 참고하세요.
추가적인 설정 옵션
Pywikibot은 봇의 동작을 조작하는 다양한 설정 옵션을 제공합니다. 이 설정들은 "user-config.py"에서 변경할 수 있습니다. 사용가능한 전체 파라미터의 목록은 config.py에서 볼 수 있습니다.
프록시 설정
Pywikibot은 인터넷과 통신하기 위해 requests에 의존합니다.
HTTP_PROXY와 HTTPS_PROXY 환경변수를 이용해 요청이 프록시 서버를 이용하도록 할 수 있습니다.
자세한 정보는 requests의 설명문서를 참조하세요.
스크립트 가동하기
Pywikibot의 'scripts' 디렉토리 안에는 매우 많은 수의 기성 스크립트들이 있습니다. 이 스크립트들을 이용하려면 다음과 같이 입력하면 됩니다.
$ python pwb.py [name of the script]
To learn more about running basic Pywikibot scripts, see:
- Small wiki toolkits workshop about running basic Pywikibot scripts
- Self-study materials based on the small wiki toolkits workshop
- Workshop handbook based on the small wiki toolkits workshop
모든 스크립트 목록은 메뉴얼:Pywikibot/스크립트 및 doc.wikimedia.org/pywikibot에서 확인할 수 있습니다.
그 외 필요물
대부분의 스크립트는 여러분이 바로 그대로 이용할 수 있지만, 몇몇 스크립트들은 추가적으로 설치해야 할 것이 있을 수 있습니다. 그런 스크립트들과 해당 스크립트에 필요한 설치품이 무엇인지 확인하려면 requirements.txt을 참고하세요.
일부 스크립트의 의존성 패키지를 설치하기 위해서는 "pip"를 사용하고, 다음의 명령어를 실행하세요.
$ python -m pip install [name of the package]
대안으로, 한번에 모든 스크립트의 의존성 패키지를 설치하기 위해서는 다음의 명령어를 실행하세요.
$ python -m pip install -r requirements.txt
- If you need more help on setting up your Pywikibot visit the #pywikibot IRC channel connect or pywikibot@ mailing list.