Manual:Pywikibot/Compat/Basic use/it

Questa pagina è disponibile in altre lingue: en - fr - nl - pl - pt - it - de


 * Se si ha bisogno di ulteriore aiuto nel settare il pywikipediabot, sono disponibili i canali: #botolatori @ irc.eu.freenode.net dove è possibile chiedere aiuto in italiano, e #pywikipediabot @ freenode server dove è possibile chiedere aiuto in inglese.

Il framework di Wikipediabot Python (abbreviata pywikipedia) è un framework standard per semplificare la creazione di bot script per MediaWiki. Il pacchetto include una serie di script già pronti per i compiti più comuni di un bot. Questa pagina introduce il framework e ne fornisce la documentazione.

Python
Prima di poter usare il bot, è necessario installare l'interprete per il linguaggio di programmazione Python, nella versione 2.3 o successiva. Python è già presente nella maggior parte delle distribuzioni dei sistemi operativi Unix, Mac OS X, Linux, BSD e altri *nix. Tuttavia, se è installata una vecchia versione, potrebbe essere necessario aggiornarla. Se il tuo sistema operativo è Microsoft Windows o non è comunque tra i precedenti e non conosci il Python, probabilmente non sarà installato sulla tua piattaforma. Se non possiedi l'interprete Python puoi procurartelo dalla pagina di download del sito ufficiale. L'interprete può funzionare su tutte le più comuni piattaforme, sia per quelle menzionate sopra che per Microsoft Windows.

Pacchetto
Il framework del bot è liberamente scaricabile tramite sourceforge nella pagina dedicate, dove è sempre presente la versione stabile del pacchetto. Il pacchetto può essere scaricato e installato con uno sforzo relativamente ridotto, ma spesso è datato.

Via CVS
Una versione aggiornata può essere recuperata usando un Concurrent Versions System tramite la pagina di download di pywikipedia. Per far ciò è necessario un client CVS, sebbene sia possibile scaricare entrambi i file singolarmente, anche senza di esso. Un client CVS è presente in tutte le versioni Unix (eccetto in Gentoo, dove è ottenibile tramite il comando emerge cvs. Le installazioni minimali di Debian non includono CVS. In queste, se è necessario, bisogna usare il comando apt-get install cvs), ma è necessario scaricarlo ed installarlo separatamente per Windows. Se stai utilizzando Windows, è consigliato il client Tortoise CVS.

Dalla linea di comando di Unix o dal prompt dei comandi di Windows, naviga fino alla directory dove hai scaricato pyWikipedia e digita i seguenti comandi (puoi semplicemente fare copia/incolla utilizzando il tasto destro del mouse). Se stai utilizzando Windows, non includere il simbolo "$".

$ cvs -d :pserver:anonymous@pywikipediabot.cvs.sourceforge.net:/cvsroot/pywikipediabot login Password: (nessuna password, premi semplicemente invio a questo punto) $ cvs -d :pserver:anonymous@pywikipediabot.cvs.sourceforge.net:/cvsroot/pywikipediabot co pywikipedia

Per ulteriori aggiornamenti, spostati nella directory di pywikipedia e digita:

$ cvs up -Pd

Le istruzioni per l ' interfaccia grafica dell'utente dipendono dal software usato. Le seguenti informazioni dovrebbero essere fornite al client in modo appropriato.

Dopo il download
Il framework non necessita di nessuna installazione e sarà utilizzabile non appena essa sarà scaricata. Per lavorare sotto Python25 i file dovranno però essere scaricati nella cartella d'installazione dell'interprete (generalmente "C:\Python25". Se pensi di utilizzare personalmente il bot, considera la possibilità di iscriverti alla bot mailing list, che provvederà ad avvertirti non appena saranno rilasciate nuove versioni.

Approvazione del bot
Assicurati che il tuo bot sia stato approvato dalla comunità della Wikipedia su cui hai in mente di utilizzarlo. I progetti differenti hanno diverse procedure e pretendono diversi requisiti. Se non sei sicuro, dovresti richiedere informazioni alla comunità locale. In it.wiki, i bot devono seguire le regole e la procedure stabilite dalla comunità in lingua italiana.

Creare un account per il bot
Usando un normale browser, puoi creare un nuovo account nella Wikipedia scelta. Il nome dovrebbe specificare che è un bot e, preferibilmente, chi lo sta utilizzando. Sebbene esistano molteplici varianti per far ciò, il metodo più comune è di combinare il nick dell'utente con la parola "bot", ad esempio "Nomebot". Assicurati di selezionare la skin Monobook nelle preferenze dell'account (questa è l'impostazione della maggior parte delle wikipedie, inclusa quella italiana).

Configurare il bot
Crea un nuovo file intitolato user-config.py nella directory del bot. Aggiungi poi il seguente codice, cambiandone i valori in modo appropriato:

mylang = 'it' family = 'wikipedia' usernames['wikipedia']['it'] = 'EsempioBot' console_encoding = 'utf-8'


 * mylang (linguaggio del codice): è il linguaggio ISO 693 di Wikipedia, in genere specificato dal sottodominio (it.wikipedia.org); Il codice che indica Wikipedia in lingua italiana è "it". Se il tuo bot deve girare su Wikimedia Commons, il codice da utilizzare è "commons".
 * family (nome del progetto): è il nome del progetto, ad esempio "wikipedia", "wiktionary" o "wikisource". Se la wiki di riferimento non fa parte di Wikimedia, leggi Myproject family.py e Pywikipedia bot in progetti non-Wikimedia.
 * usernames (nome utente): è il nome utente del bot, con associato il linguaggio di programmazione e il nome del progetto. Puoi selezionare account multipli per usarlo su progetti differenti.
 * console encoding (console di codifica): se stai lavorando in un Mediawiki Unicode (come Wikimedia), è necessario impostare la codifica UTF-8 per i caratteri della tua console. In questo modo i caratteri UTF non appariranno come punti interrogativi ("????"). Puoi rimuovere questa linea di codice se vuoi usare la codificazione di default della tua console.

Eseguire uno script
Il framework di pywikipedia accetta gli input dell'utente da linea di comando, chiamato Prompt dei comandi in Windows. Raggiungi (tramite linea di comando) la directory contenente i file e digita "python nomescript.py" per attivare uno script, tralasciando facoltativamente "python" se stai utilizzando Windows.

Il primo script che si dovrebbe eseguire è login.py, che permetterà al bot di effettuare l'accesso su Wikipedia o nel progetto scelto. Quando questo chiederà d'inserire la password, inserisci la password dell'account del bot. In genere questo script dovrebbe essere eseguito solamente una volta, poiché il bot, solitamente, non si disconnette.

In seguito, si può utilizzare uno degli script già pronti, citati nell'elenco sottostante. Ogni script accetta vari argomenti che gli specificano cosa esso debba fare, ad esempio cosa sostituire o quale pagina modificare. Esiste un set di argomenti standard che è compatibile con tutti gli script; per ulteriori informazioni, controlla la sezione Argomenti standard.

(nota: i wikilink dell'elenco che puntano a pagine in italiano sono in corsivo)
 * Script Principali
 * category.py
 * imagetransfer.py
 * interwiki.py
 * redirect.py
 * replace.py — cerca e sostituisce nelle voci, usando facoltativamente le regex.
 * solve disambiguation.py
 * table2wiki.py
 * template.py
 * upload.py
 * weblinkchecker.py
 * spellcheck.py


 * Altri script usati nella Wikipedia in italiano:
 * sistemaredirect.py
 * welcome.py


 * Altri bot script:
 * catall.py
 * copyright.py
 * delete.py
 * editarticle.py
 * getimages.py
 * imageharvest.py
 * pagelist.py
 * pagefromfile.py
 * standardize interwiki.py
 * standardize notes.py
 * touch.py
 * warnfile.py


 * Programmi ausiliari:
 * login.py
 * splitwarning.py
 * test.py
 * xmltest.py

Argomenti standard
Ogni script accetta vari argomenti che gli specificano cosa esso debba fare, ad esempio cosa sostituire o quale pagina modificare. Di seguito è presente un elenco di argomenti standard è compatibile con tutti gli script, salvo diverse indicazioni scritte in modo esplicito nel codice dello stesso.

Esempio: python nomescript.py -lang:it -family:wiktionary     // Esegue lo script di nome "nomescript.py" su it.wiktionary

"Flag" del bot
Un massiccio uso dei bot potrebbe ingombrare la pagina "Ultime modifiche". Per evitare che ciò accada, devi registrare il tuo bot in modo da inserirlo nel gruppo "Bot". In questo modo, nelle RC, gli edit del tuo bot saranno nascosti, eccetto nel caso in cui un utente non selezioni appositamente l'opzione per visualizzare gli edit dei bot. È necessario ottenere il flag per il tuo bot se esso deve modificare molte pagine ogni volta che viene avviato.

Lo status di bot può essere assegnato da un burocrate. Se il tuo progetto non dispone di burocrati o se il tuo bot deve girare su meta, la richiesta deve essere fatta nella pagina Requests for bot status. Spesso gli steward avranno bisogno di una prova che dimostri che la comunità locale è favorevole al bot.

Per registrare il tuo bot su it.wiki consulta la pagina apposita.

Richiesta di nuove caratteristiche
Se vuoi avere una funzione che al momento non è fornita da nessun altro bot, puoi chiedere ad uno dei programmatori di scrivere il codice per te. O, ancora meglio, puoi provare a lavorarci da solo per utilizzarla col tuo bot. Python, infatti, è un buon linguaggio e non è molto difficile da imparare. Perciò ti invitiamo a provarci.

Usare il bot per una wiki locale
Consulta Pywikipedia bot in progetti non-wikimedia per le informazioni sulla configurazione del tuo bot per usarlo in un progetto non facente parte di Wikimedia, creati con il software Mediawiki.

Consigli per scrivere il tuo bot
Qui ci sono alcuni consigli basilari per iniziare a scrivere il tuo bot:
 * Innanzi tutto assicurati di aver settato il file user-config.py (se non l'hai fatto, controlla il paragrafo Configurare il bot)
 * Usa  per accedere al framework di pywikipedia.
 * Per scaricare una pagina, utilizza il seguente codice, dove pageName è, ad esempio, "Wikipedia:Bot" o "India":

site = wikipedia.getSite page = wikipedia.Page(site, pageName) text = page.get wikipedia.stopme


 * Per aggiornare una pagina, utilizza invece:

page.put(newText)

Se desideri aggiornare una pagina, ti dovrai loggare:

import login loginMan = login.LoginManager('your pass', False, s)

Se hai più di un processo attivo, pywikipedia metterà ogni nuovo processo in standby per un po' di tempo prima di eseguirlo. import wikipedia import login
 * Concludi sempre il tuo bot con . Se te ne dimentichi, il processo che hai iniziato non terminerà dopo aver eseguito lo script e avrà bisogno di un po' di tempo per "scadere".
 * Ecco un esempio di aggiunta di testo alla Pagina delle prove:

s=wikipedia.Site('it') login.LoginManager('la tua password', False, s) p = wikipedia.Page(s,'Wikipedia:Pagina delle prove') p.get p.put(p.get + '\n\nProva')

wikipedia.stopme
 * da un'occhiata ad alcuni dei file di pywikipedia per altre idee -- replace.py è relativamente semplice da leggere anche se sei nuovo nell'utilizzare pywikipedia.
 * puoi trovare tutti i metodi "wikipedia.Page" nel file wikipedia.py.

Caricare le patch
Se hai modificato il bot e vuoi spedire una patch agli sviluppatori:


 * 1) Aggiorna la versione corrente (ciò unirà i tuoi cambiamenti con i miglioramenti già compiuti al repository CVS);
 * 2) Risolvere gli eventuali conflitti causati dall'update (verifica ciò usando  );
 * 3) In seguito digita: $ cvs diff > cvs.diff

Puoi poi spedire il file cvs.diff agli sviluppatori e chiedere loro di includere i cambiamenti (è meglio che tu riveda la differenze prima di spedirglielo). Le linee inizianti con "?" potrebbero essere rimosse.