Start by connecting <connecting> to your site:
>>> from mwklient import Site >>> site = Site('en.wikipedia.org')
For information about authenticating, please see the section on authenticating <auth>.
To get the content of a specific page:
>>> page = site.pages['Greater guinea pig'] >>> text = page.text()
If a page doesn't exist, Page.text() <mwklient.page.Page.text> just returns an empty string. If you need to test the existence of the page, use `page.exists`:
>>> page.exists True
Edit the text as you like before saving it back to the wiki:
>>> page.edit(text, 'Edit summary')
If the page didn't exist, this operation will create it.
Page.revisions() <mwklient.page.Page.revisions> returns a List object that you can iterate over using a for loop. Continuation is handled under the hood so you don't have to worry about it.
Example: Let's find out which users did the most number of edits to a page:
>>> users = [rev['user'] for rev in page.revisions()] >>> unique_users = set(users) >>> user_revisions = [{'user': user, 'count': users.count(user)} for user in unique_users] >>> sorted(user_revisions, key=lambda x: x['count'], reverse=True)[:5] [{'count': 6, 'user': u'Wolf12345'}, {'count': 4, 'user': u'Test-bot'}, {'count': 4, 'user': u'Mirxaeth'}, {'count': 3, 'user': u'192.251.192.201'}, {'count': 3, 'user': u'78.50.51.180'}]
Tip: If you want to retrieve a specific number of revisions, the itertools.islice method can come in handy:
>>> from datetime import datetime >>> from time import mktime >>> from itertools import islice >>> for revision in islice(page.revisions(), 5): ... dt = datetime.fromtimestamp(mktime(revision['timestamp'])) ... print '{}'.format(dt.strftime('%F %T'))
To revert / undo the edit of a specific page:
>>> page.undo(rev_id, summary='reverted this edit')
Categories can be retrieved in the same way as pages, but you can also use Site.categories() <mwklient.client.Site.categories> and skip the namespace prefix. The returned Category <mwklient.listing.Category> object supports the same methods as the Page <mwklient.page.Page> object, but also provides an extra function, members() <mwklient.listing.Category.members>, to list all members of a category.
The Category object can also be used itself as an iterator to yield all its members:
>>> category = site.categories['Python'] >>> for page in category: >>> print(page.name)
There are many other page operations like backlinks() <mwklient.page.Page.backlinks>, embeddedin() <mwklient.page.Page.embeddedin>, etc. See the API reference <mwklient.page.Page> for more.