Wikipédia:Pywikibot

Robôs
Política de robôs Coordenação robótica Grupo de aprovação de bots Pedidos de aprovação Lista de robôs Como criar um robô História dos robôs

Pywikibot é um software para os projetos da Wikimedia e também para sites que funcionam com o MediaWiki.

O Pywikibot é escrito em Python e o MediaWiki escrito em PHP, portanto o Pywikibot é uma biblioteca com todas as funções do MediaWiki para assim realizar tarefas rotineiras e de manutenção da Wikipédia, por exemplo.

Nesta página, os editores que desejam executar o bot podem encontrar informações importantes de instalação e execução. Você pode pedir ajuda com seu robô na Coordenação Robótica da Wikipédia.

Iniciando o bot

Download

Para usar o bot, você precisará do software do bot e, pelo menos, do Python versão 3.3, que você pode instalar seguindo os passos na página oficial de download.

Python está instalado por padrão em algumas distribuições Unix, portanto talvez você só precise atualizá-lo no caso de estar usando uma versão muito antiga. Python pode ser executado em todos os sistemas operacionais conhecidos, como Unix, Linux, Mac e Windows.

A versão mais recente do software do bot está disponível usando Git ou como um arquivo compactado. Arquivos compactados são mais fáceis de baixar, porém podem ser mais complicados de atualizar. Baixe a versão estável mais atual do Pywikibot aqui: .tar.gz ou .zip. Descompacte o arquivo.

Para atualizar, faça o download da versão mais recente e cole na pasta da raiz do bot, sobrescrevendo todos os arquivos.

É aconselhável instalar o Pywikibot em um caminho de pasta sem acentos ou caracteres especiais.

Configurando para a Wikipédia

A maneira mais fácil de criar o arquivo de configuração é executar o arquivo generate_user_files.py no terminal. Siga os passos solicitados pelo programa.

Se isso não funcionar por algum motivo, você pode digitar a configuração diretamente no arquivo, adicionando o seguinte código em algum lugar do artigo:

use_api = True
family = 'wikipedia'
mylang = 'pt'
usernames['wikipedia']['pt'] = u'Nome de usuário'  # altere o nome de usuário para sua conta de robô

Se você deseja usar o bot em mais de uma wiki, digite os nomes de usuário de forma semelhante à última linha, por exemplo:

usernames['wikipedia']['es'] = u'Robônino'
usernames['wikinews']['en'] = u'Robôringo'
usernames['wiktionary']['de'] = u'Robôlogista'

Salve o arquivo de texto user-config.py na pasta raiz do Pywikibot (onde pwb.py também está localizado). Certifique-se de salvar o arquivo no modo UTF-8.

Se você é um administrador da wiki e deseja que o bot use seu usuário de administrador quando você precisar, por exemplo, editar uma página protegida, digite o nome de usuário dessa conta da seguinte forma:

sysopnames['wikipedia']['pt'] = u'Le Administrador'

Pedir permissão para usar o robô

Na Wikipédia, os usuários precisam solicitar autorização para operar.

Os pedidos de autorização para os bots operarem são efetuados em Wikipédia:Robôs/Pedidos de aprovação, e nenhum bot pode operar sem autorização, seja ele operado em modo automático ou semi-automático, com ou sem supervisão. Durante o período de testes, o bot é posto à prova, para evitar que scripts ou programas inflijam erros ou diminuam a qualidade de artigos massivamente. Uma vez que os bots efetuam um elevado número de edições num curto espaço de tempo, todo o cuidado é pouco, e tanto os operadores como o restante da comunidade devem sempre ter em conta que por mais desenvolvido que um script esteja, não é possível prever todas as situações, podendo ocorrer erros. Daí a necessidade de uma constante avaliação das edições do bot.

Executando

Selecione e execute um script

Após configurar o Pywikibot, você está pronto para executá-lo. Para fazer isso, você precisa abrir o terminal no seu sistema operacional.

No Windows, clique com o botão direito em "Iniciar" e então "Prompt de Comando". Em seguida, abra o diretório onde está localizada a biblioteca do Pywikibot. Você pode navegar entre as pastas usando o comando cd.
No Mac, pesquise por "Terminal" no Spotlight.
No Linux ou Unix, execute o terminal. Em seguida, abra o diretório onde está localizada a biblioteca do Pywikibot. Você pode navegar entre as pastas usando o comando cd.

Primeiro, faremos login. Na pasta raiz do pywikibot, digite python pwb.py login. O programa irá solicitar o nome e a senha de robô, dados que você poderá obter nesta página especial. Se você não alterar sua senha, você só precisará fazer login uma vez, porque geralmente o bot não faz logout.

Você então pode executar qualquer script digitando python pwb.py nomedoscript. Você pode ver uma lista de scripts nesta página no MediaWiki. Você também pode executar comandos de linha, como -help, -lang:xx, -family:xyz.

Você também pode usar a biblioteca do Pywikibot para criar seus próprios scripts e até interagir com o Wikidata, bem como ajudar em seu desenvolvimento.