Difference between pages "User:Mathieu/Test" and "User:Mathieu/bot"
From Event-B
< User:Mathieu(Difference between pages)
Jump to navigationJump to searchimported>Mathieu |
imported>Mathieu (Bot configuration and usage) |
||
Line 1: | Line 1: | ||
− | + | A bot may be a useful tool to help a wiki maintenance. | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | I tried to use the python framework provided by http://pywikipediabot.sourceforge.net/. Hereafter are some guidelines to make it work on this wiki. | |
− | |||
− | |||
− | + | == Requirements == | |
− | + | * Python >2.5 | |
− | |||
− | |||
− | + | == Getting pywikipedia framewok == | |
− | </ | + | Get the source code from subversion: |
+ | <pre><nowiki> | ||
+ | (prompt) svn co http://svn.wikimedia.org/svnroot/pywikipedia/trunk/pywikipedia pywikipedia | ||
+ | </nowiki></pre> | ||
+ | == Configuring the framework for this wiki == | ||
+ | Add the following <tt>families/eventb_family.py</tt> file (be careful with the indentation): | ||
+ | <pre><nowiki> | ||
+ | # -*- coding: utf-8 -*- | ||
− | == | + | import family |
+ | # The event-b family | ||
+ | # user-config.py: usernames['event-b']['event-b'] = 'User name' | ||
+ | class Family(family.Family): | ||
+ | def __init__(self): | ||
+ | family.Family.__init__(self) | ||
+ | self.name = 'eventb' | ||
+ | self.langs = { | ||
+ | 'eventb': 'wiki.event-b.org', | ||
+ | } | ||
− | + | self.namespaces[4] = { | |
+ | '_default': [u'Event-B', self.namespaces[4]['_default']], | ||
+ | } | ||
+ | |||
+ | self.namespaces[5] = { | ||
+ | '_default': [u'Event-B talk', self.namespaces[5]['_default']], | ||
+ | } | ||
+ | |||
+ | def version(self, code): | ||
+ | return '1.11' | ||
+ | |||
+ | def path(self, code): | ||
+ | return '/index.php' #The path of index.php, look at your wiki address. | ||
+ | |||
+ | def scriptpath(self,code): | ||
+ | return '' | ||
+ | |||
+ | # def shared_image_repository(self, code): | ||
+ | # return ('commons', 'commons') | ||
+ | '_default': [u'Event-B talk', self.namespaces[5]['_default']], | ||
+ | </nowiki></pre> | ||
+ | |||
+ | Then add the following <tt>user-config.py</tt> file: | ||
+ | <pre><nowiki> | ||
+ | family='eventb' | ||
+ | mylang='eventb' | ||
+ | usernames['eventb']['eventb'] = 'your_bot_user_name' | ||
+ | </nowiki></pre> | ||
+ | |||
+ | == Usage == | ||
+ | === Login === | ||
+ | First you should log in: | ||
+ | <pre><nowiki> | ||
+ | (prompt) python login.py | ||
+ | </nowiki></pre> | ||
+ | === Upload Images === | ||
+ | <pre><nowiki> | ||
+ | (prompt) python upload.py -noverify -keep file.png "Image description" | ||
+ | </nowiki></pre> | ||
+ | |||
+ | For uploading several images from a directory, I use the following ''sh'' command: | ||
+ | <pre><nowiki> | ||
+ | for i in /tmp/imagedir/* ; do (yes | python upload.py -v -noverify -keep $i "Import of image $i"); done | ||
+ | </nowiki></pre> |
Revision as of 13:48, 6 July 2008
A bot may be a useful tool to help a wiki maintenance.
I tried to use the python framework provided by http://pywikipediabot.sourceforge.net/. Hereafter are some guidelines to make it work on this wiki.
Contents
Requirements
- Python >2.5
Getting pywikipedia framewok
Get the source code from subversion:
(prompt) svn co http://svn.wikimedia.org/svnroot/pywikipedia/trunk/pywikipedia pywikipedia
Configuring the framework for this wiki
Add the following families/eventb_family.py file (be careful with the indentation):
# -*- coding: utf-8 -*- import family # The event-b family # user-config.py: usernames['event-b']['event-b'] = 'User name' class Family(family.Family): def __init__(self): family.Family.__init__(self) self.name = 'eventb' self.langs = { 'eventb': 'wiki.event-b.org', } self.namespaces[4] = { '_default': [u'Event-B', self.namespaces[4]['_default']], } self.namespaces[5] = { '_default': [u'Event-B talk', self.namespaces[5]['_default']], } def version(self, code): return '1.11' def path(self, code): return '/index.php' #The path of index.php, look at your wiki address. def scriptpath(self,code): return '' # def shared_image_repository(self, code): # return ('commons', 'commons') '_default': [u'Event-B talk', self.namespaces[5]['_default']],
Then add the following user-config.py file:
family='eventb' mylang='eventb' usernames['eventb']['eventb'] = 'your_bot_user_name'
Usage
Login
First you should log in:
(prompt) python login.py
Upload Images
(prompt) python upload.py -noverify -keep file.png "Image description"
For uploading several images from a directory, I use the following sh command:
for i in /tmp/imagedir/* ; do (yes | python upload.py -v -noverify -keep $i "Import of image $i"); done