Manual:Pywikibot/Instalação
Abaixo está o manual para ajudá-lo a configurar e executar o Pywikibot em seu próprio computador. São quatro etapas principais para este processo:
Instalando Python
Baixe e instale o Python no https://www.python.org/downloads/.
Caso você já tenha Python instalado, verifique se a versão é recente o suficiente, executando python --version no console.
Para descobrir se a versão 3 ou acima do Python está instalada, execute python3 --version em um console.
Ubuntu 19.04 e acima vem com as versões 2 & 3 instaladas.
Python v2 funciona por padrão usando o comando terminal python; para usar v3, use o comando terminal python3.
Python 3.7 or higher is currently required to run the bot. No Windows, não esqueça de modificar a variável do caminho PATH para fazer com que o Python e o pip funcionem corretamente.
Instalar dependências
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
Instalando Pywikibot
$ python -m pip install pywikibot
Ao usar pip, use pwb ao invés de python pwb.py nos exemplos abaixo.
Baixe a versão mais atual do Pywikibot de número stable: .tar.gz, .zip.
Descompacte o arquivo baixado, por exemplo em ~/pywikibot ou %USERPROFILE%\pywikibot.
Alternativamente, você pode obter a última versão usando clientes git ou svn do Gerrit, veja Manual:Pywikibot/Gerrit#For users. É o recomendado para operadores e desenvolvedores ativos de bots para Pywikibot.
Outras versões estão disponíveis em https://pywikibot.toolforge.org/.
Atualizando Pywikibot
Mantenha o framework do seu bot atualizado. Novas versões são lançadas continuamente, e estão disponibilizadas no mesmo local.
Se você estiver usando git ou svn, você pode pular essa parte. Senão, tenha em mente a necessidade de fazer um backup de seus arquivos de configuração e scripts (user-config.py, qualquer arquivo de família, ou script customizado que você criou ou modificou, e qualquer arquivo de dump XML que você está usando atualmente para uma wiki) antes de instalar uma nova versão.
Descompacte a nova versão sobre a versão antiga, sobrescrevendo todos os arquivos.
Configurando Pywikibot
Abra o Terminal no Unix (Linux/BSD/Solaris) ou Prompt de Comando no Windows (normalmente nas pastas Sistema ou Acessórios no menu Todos os Programas dentro do menu Inciar), e mude o diretório para onde você descompactou o Pywikibot:
- Unix (Linux/BSD/Solaris):
$ cd ~/core
- Windows:
$ c: $ cd "%USERPROFILE%\pywikibot"
Substitua o local por onde você desempacotou o Pywikibot.
Continue com o seguinte comando para gerar o arquivo de configuração do usuário:
$ python pwb.py generate_user_files
Siga as instruções para configurar o Pywikibot.
Finalmente, execute o seguinte comando para efetuar login na sua wiki:
$ python pwb.py login
Uso em wikis de terceiros
Pywikibot é pré-configurado para um grande número de wikis, mas possivelmente não para aquela em que você quer trabalhar. Veja Manual:Pywikibot/Use on third-party wikis para saber como configurar o Pywikibot para a sua wiki.
Mais opções de configuração
Pywikibot disponibiliza um gama extensa de opções de configuração para mudar o comportamento de seu robô. Você pode alterar essas opções no arquivo user-config.py. Veja config.py para uma lista com todos os parâmetros que você pode usar.
Configuração de proxy
Pywikibot depende de requests para comunicar com a web.
Você pode usar as variáveis dos caminhos HTTP_PROXY e HTTPS_PROXY para fazer requests usando um servidor proxy.
Veja documentação de requests para mais informações.
Execução do script
O Pywikibot vem empacotado com um grande número de scripts no diretório scripts. Você pode rodar todos esses usando:
$ 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
Uma lista de todos os scripts estão disponíveis em $scripts.
Outras dependências
A maioria dos scripts não requer pacotes adicionais, mas alguns deles não funcionarão sem. Eles estão listados em requirements.txt juntamente com suas dependências.
Para instalar dependências para algum script, use pip e execute o seguinte comando:
$ python -m pip install [name of the package]
Como alternativa, execute o seguinte comando para instalar todas as dependências de todos os scripts de uma só vez:
$ python -m pip install -r requirements.txt
- Se você precisar de mais ajuda na configuração do seu Pywikibot, visite o canal #pywikibot IRC connect ou pywikibot@ lista de discussão.