Pywikibot

Quick start

Basic Usage

importpywikibotsite=pywikibot.Site('en','wikipedia')# The site we want to run our bot onpage=pywikibot.Page(site,'Wikipedia:Sandbox')page.text=page.text.replace('foo','bar')page.save('Replacing "foo" with "bar"')# Saves the page

Wikibase Usage

importpywikibotsite=pywikibot.Site('wikipedia:en')repo=site.data_repository()# the Wikibase repository for given sitepage=repo.page_from_repository('Q91')# create a local page for the given itemitem=pywikibot.ItemPage(repo,'Q91')# a repository itemdata=item.get()# get all item data from repository for this item

Script example

importpywikibotfrompywikibotimportpagegeneratorsfrompywikibot.botimportExistingPageBotclassMyBot(ExistingPageBot):update_options= {'text':'This is a test text','summary':'Bot: a bot test edit with Pywikibot.'    }deftreat_page(self):"""Load the given page, do some changes, and save it."""text=self.current_page.texttext+='\n'+self.opt.textself.put_current(text,summary=self.opt.summary)defmain():"""Parse command line arguments and invoke bot."""options= {}gen_factory=pagegenerators.GeneratorFactory()# Option parsinglocal_args=pywikibot.handle_args(args)# global optionslocal_args=gen_factory.handle_args(local_args)# generators optionsforarginlocal_args:opt,sep,value=arg.partition(':')ifoptin ('-summary','-text'):options[opt[1:]]=valueMyBot(generator=gen_factory.getCombinedGenerator(),**options).run()if__name=='__main__':main()

Roadmap

Release history

Contributing