Manual:Pywikibot/Instalação

Esta página ajudará você a começar a usar o Pywikibot, seja no seu próprio computador, no Toolforge ou usando o PAWS: A Web Shell.

No PAWS

PAWS: A Web Shell é a maneira mais fácil de começar a usar o Pywikibot. Nenhuma instalação é necessária, e você usa a interface web para submeter comandos.

Rodando Pywikibot em PAWS

No seu próprio computador

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 o Python
• Instalando Pywikibot
• Configurando Pywikibot
• Executando um script

No Toolforge

O Toolforge fornece uma infraestrutura de hospedagem estável na Wikimedia, que permite executar bots continuamente ou em uma programação.

Executando Pywikibot na Toolforge

Pywikibot
Visão geral rápida Instalação Executando em PAWS Executando em Windows Executando em Toolforge Configuration and scripts user-config.py Opções globais i18n Scripts Uses Wikidata Wikis não Wikimedia Desenvolvimento Ajuda adicional Mais... »

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.

Caso você tenha Python $py2 ou maior, ou Python $py3 ou maior instalado, a sua versão é sufucientemente recente.

De qualquer forma, versões do Python abaixo da 3.5 serão descontinuadas em um futuro próximo. É estritamente recomendado usar Python 3.5 ou superior.

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

Um pacote adicional chamado "requests" é necessário para rodar Pywikibot. Use pip, que já está instalado se você tem 2.7.9 ou superior, ou Python 3.4 ou superior. Rode o comando seguinte para instalar o pacote:

$ pip install "requests>=2.20.1"

Para Python 2.7, são obrigatórios os seguintes pacotes:

$ pip install "enum34>=1.1.6!=1.1.8"
$ pip install ipaddress
$ pip install pathlib2

Instando Pywikibot

Baixe a versão mais atual do Pywikibot: stable: .tar.gz, .zip.

Python 2.7 users should download the stable python2 branch: .tar.gz, .zip instead.

Desemcompacte o arquivo baixado, por exemplo em /home/username/pywikibot ou C:\Users\username\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://tools.wmflabs.org/pywikibot/.

Atualizando Pywikibot

Mantenha o framework do seu bot atualizado. Novas versões são lançadas continuamente, e estão disponibilizadas no mesmo local.

If you are using git or svn release, you may skip this note. Otherwise please be aware of a necessity to backup your configuration files and scripts (user-config.py, any family file, or custom script that you might have created or changed, and any current XML dump file you're using for a wiki) before installing a new release.

Desembale a nova versão sobre a versão antiga, sobrescrevendo todos os arquivos.

Configure Pywikibot

Open Terminal on Unix-like (Linux/BSD/Solaris) or Command Prompt on Windows (typically under Windows System or Accessories folders in All apps or All programs menu inside the Start menu), and change directory to where you unpacked Pywikibot:

Unix-like (Linux/BSD/Solaris):

$ cd ~/pywikibot

Windows:

$ c:
$ cd "\Users\username\pywikibot"

É claro que deve-se substituir 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 no seu wiki:

$ python pwb.py login

Use em wikis de terceiros

Pywikibot is pre-configured for a large number of wikis, but possibly not for the one you want to work on. See Manual:Pywikibot/Use on third-party wikis for how to configure Pywikibot for your wiki.

Mais opções de configuração

Pywikibot provides a wide range of configuration options to change the behavior of your bot. Você pode alterar essas opções no arquivo "user-config.py". See config2.py for a list of all parameters you can use.

Configuração de proxy

Pywikibot relies on requests for communicating with the web. You can use HTTP_PROXY and HTTPS_PROXY environment variables to make requests use a proxy server. Refer to requests' documentation for more info.

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]

Uma lista de todos os scripts estão disponíveis em Manual:Pywikibot/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:

$ 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:

$ pip install -r requirements.txt

Se você precisar de mais ajuda para configurar seu Pywikibot, visite o canal de IRC irc