Руководство:Pywikibot/Установка
Это руководство позволит вам установить и запустить Pywikibot на своём компьютере. Оно состоит из 4-х основных шагов:
Установка Python
Загрузите и установите Python с https://www.python.org/downloads/.
Если у вас уже установлен 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.
Python 3.6.1 or higher is currently required to run the bot, but Python 3.7 or higher is recommended. При работе в Windows не забудьте отредактировать переменную среды PATH для корректной работы Python и pip.
Установка зависимостей
Дополнительный пакет, называёмый requests необходим для запуска Pywikibot. Используйте pip, который по умолчанию включен во все поддерживаемые версии Python. Используйте нижеприведённые команды для установки этого пакета:
$ python -m pip install "requests>=2.20.1"
In addition a MediaWiki markup parser is required. Please install (at least) one of the following (or both):[1]
$ python -m pip install "mwparserfromhell>=0.5.0"
$ python -m pip install "wikitextparser>=0.47.5"
Установка 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 или c:\users\username\pywikibot.
Также можно получить последнюю версию, используя git или svn из Gerrit, см. Manual:Pywikibot/Gerrit#For users. Этот способ рекомендуется активным ботоводам и разработчикам, использующим Pywikibot.
Старые версии доступны по адресу https://pywikibot.toolforge.org/.
Обновление
Сохраняйте среду запуска своего бота в актуальном состоянии. Новые версии выходят непрерывно и доступны по тому же адресу.
Если вы используете выпуск с git или svn, то можете пропустить этот этап. В противном случае помните о необходимости сделать резервную копию ваших файлов настроек конфигурации и скриптов ("user-config.py", family-файла или своих скриптов, которые вы могли создать или изменить, и какого-либо текущего XML-дампа, который вы используете для вики) перед установкой нового выпуска.
Распакуйте новую версию поверх старой, перезапишите все файлы.
Настройка Pywikibot
Откройте терминал в UNIX-подобной системе (Linux/BSD/Solaris) или "Командную строку" в Windows и смените директорию на ту, в которую вы распаковали pywikibot.
- Unix-подобные системы (Linux/BSD/Solaris):
$ cd ~/core
- Windows:
$ c: $ cd "\Users\username\pywikibot"
Разумеется, заменив на тот путь, куда вы распаковали pywikibot.
Продолжайте с нижеприведёнными командами для генерации файла настроек пользователя:
$ python pwb.py generate_user_files
Следуйте инструкциям, чтобы настроить Pywikibot.
Наконец запустите нижеприведённую команду в лог в свою Вики:
$ python pwb.py login
Использование в частном вики-проекте
Pywikibot уже предварительно настроен для большого количества вики-сайтов, но, возможно, не для того, с которым вы хотите работать. Смотрите Manual:Pywikibot/Use on third-party wikis для настройки Pywikibot для вашей вики.
Дополнительная настройка
Pywikibot обеспечивает широкие возможности настройки для изменения поведения вашего бота. Вы можете изменить эти настройки в файле user-config.py. Смотрите в config.py список всех параметров, которые вы можете использовать.
Конфигурация прокси
Для связи с сетью Pywikibot использует библиотеку requests.
Чтобы 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
Список всех скриптов доступных в $scripts.
Другие зависимости
Большинство скриптов не требую дополнительных пакетов, но некоторые могут не заработать без них. Они перечислены в 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 подключиться or pywikibot@ mailing list.