Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
mwclient
========
Mwclient is a client to the `MediaWiki API`_ which provides access to most
API functionality. It depends heavily on Bob Ippolito's SimpleJSON_,
requires Python 2.4 and supports MediaWiki 1.11 and above. For functions not
available in the current MediaWiki, a ``MediaWikiVersionError`` is raised.
This framework was written by Bryan Tong Minh, who released the latest stable
`version 0.6.5`_ at 6 May 2011. The current `development version`_ can be
installed directly off github:
.. code-block:: console
$ pip install git+git://github.com/btongminh/mwclient.git
Please see `release notes`_ for a list of changes.
Implementation notes
--------------------
Most properties and generators accept the same parameters as the API, without
their two letter prefix. Exceptions to this rule:
* ``Image.imageinfo`` is the imageinfo of the latest image. Earlier versions can be
fetched using ``imagehistory()``
* ``Site.all*``: parameter ``[ap]from`` renamed to ``start``
* ``categorymembers`` is implemented as ``Category.members``
* ``deletedrevs`` is ``deletedrevisions``
* ``usercontribs`` is ``usercontributions``
* First parameters of ``search`` and ``usercontributions`` are ``search`` and ``user``
respectively
Properties and generators are implemented as Python generators.
Their limit parameter is only an indication of the number of items in one chunk.
It is not the total limit.
Doing ``list(generator(limit = limit))`` will return ALL items of generator,
and not be limited by the limit value.
Default chunk size is generally the maximum chunk size.
HTTPS
-----
To use https, specify the host as a tuple in the form of ``('https', hostname)``.
Example
-------
For more information, see `REFERENCE.md <REFERENCE.md>`_.
.. code-block:: python
# Initialize Site object
import mwclient
site = mwclient.Site('commons.wikimedia.org')
site.login(username, password) # Optional
# Edit page
page = site.Pages['Commons:Sandbox']
text = page.edit()
print 'Text in sandbox:', text.encode('utf-8')
page.save(text + u'\nExtra data', summary = 'Test edit')
# Printing imageusage
image = site.Images['Example.jpg']
print 'Image', image.name.encode('utf-8'), 'usage:'
for page in image.imageusage():
print 'Used:', page.name.encode('utf-8'), '; namespace', page.namespace
print 'Image info:', image.imageinfo
# Uploading a file
site.upload(open('file.jpg'), 'destination.jpg', 'Image description')
# Listing all categories (don't do this in reality)
for category in site.allcategories():
print category
.. _`MediaWiki API`: http://mediawiki.org/wiki/API
.. _SimpleJSON: //github.com/simplejson/simplejson
.. _`version 0.6.5`: //github.com/btongminh/mwclient/archive/REL_0_6_5.zip
.. _`development version`: //github.com/btongminh/mwclient
.. _`release notes`: //github.com/btongminh/mwclient/blob/master/RELEASE-NOTES.md