Skip to content

Latest commit

 

History

History
 
 

pywikibot

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
comms
comms
 
 
compat
compat
 
 
data
data
 
 
families
families
 
 
tools
tools
 
 
userinterfaces
userinterfaces
 
 
CONTENT.rst
CONTENT.rst
 
 
DIRECTORIES.rst
DIRECTORIES.rst
 
 
README.rst
README.rst
 
 
__init__.py
__init__.py
 
 
_wbtypes.py
_wbtypes.py
 
 
backports.py
backports.py
 
 
bot.py
bot.py
 
 
bot_choice.py
bot_choice.py
 
 
botirc.py
botirc.py
 
 
config2.py
config2.py
 
 
cosmetic_changes.py
cosmetic_changes.py
 
 
daemonize.py
daemonize.py
 
 
date.py
date.py
 
 
diff.py
diff.py
 
 
echo.py
echo.py
 
 
editor.py
editor.py
 
 
epydoc.cfg
epydoc.cfg
 
 
exceptions.py
exceptions.py
 
 
family.py
family.py
 
 
fixes.py
fixes.py
 
 
flow.py
flow.py
 
 
i18n.py
i18n.py
 
 
interwiki_graph.py
interwiki_graph.py
 
 
logentries.py
logentries.py
 
 
logging.py
logging.py
 
 
login.py
login.py
 
 
page.py
page.py
 
 
pagegenerators.py
pagegenerators.py
 
 
plural.py
plural.py
 
 
proofreadpage.py
proofreadpage.py
 
 
site.py
site.py
 
 
site_detect.py
site_detect.py
 
 
specialbots.py
specialbots.py
 
 
textlib.py
textlib.py
 
 
throttle.py
throttle.py
 
 
titletranslate.py
titletranslate.py
 
 
version.py
version.py
 
 
weblib.py
weblib.py
 
 
xmlreader.py
xmlreader.py
 
 

README.rst

This is a package to build robots for MediaWiki wikis like Wikipedia.

Please do not play with this package.

These programs can actually modify the live wiki on the net, and proper wiki-etiquette should be followed before running it on any wiki.

To get started on proper usage of the bot framework, please refer to:

Manual:Pywikibot
External software can be used with Pywikibot:
  • Pydot, Pyparsing and Graphviz for use with interwiki_graph.py
  • JSON for use with site.py, bot.py
  • MySQLdb to access MySQL database for use with pagegenerators.py
  • PyGoogle to access Google Web API and PySearch to access Yahoo! Search Web Services for use with pagegenerators.py

Pywikibot makes use of some modules that are part of python, but that are not installed by default on some Linux distributions:

  • python-xml (required to parse XML via SaX2)
  • python-celementtree (recommended if you use XML dumps)
  • python-tkinter (optional, used by some experimental GUI stuff)

You need to have at least python version 2.6.5 or newer installed on your computer to be able to run any of the code in this package, but not 3.0-3.2. It works fine with 3.3-3.4 versions of python installed. Support for older versions of python is not planned. Some scripts could run with older python releases. Please refer the manual at mediawiki for further details and restrictions.

You do not need to "install" this package to be able to make use of it. You can actually just run it from the directory where you unpacked it or where you have your copy of the SVN or git sources.

The first time you run a script, the package creates a file named user-config.py in your current directory. It asks for the family and language code you are working on and at least for the bot's user name; this will be used to identify you when the robot is making changes, in case you are not logged in. You may choose to create a small or extended version of the config file with further informations. Other variables that can be set in the configuration file, please check config.py for ideas.

After that, you are advised to create a username + password for the bot, and run login.py. Anonymous editing is not possible.