Skip to content
Snippets Groups Projects
Commit fd7d3838 authored by Dan Michael O. Heggø's avatar Dan Michael O. Heggø
Browse files

Merge branch 'master' of git://github.com/btongminh/mwclient into iwlinks

parents 6c0ef3d7 2f2d2f91
No related branches found
No related tags found
No related merge requests found
mwclient mwclient
======== ========
Mwclient is a client to the `MediaWiki API`_ which provides access to most Mwclient is a client to the `MediaWiki API <//mediawiki.org/wiki/API>`_
API functionality. It depends heavily on Bob Ippolito's SimpleJSON_, which provides access to most API functionality.
requires Python 2.4 and supports MediaWiki 1.11 and above. For functions not It depends heavily on Bob Ippolito's `SimpleJSON <//github.com/simplejson/simplejson>`_,
available in the current MediaWiki, a ``MediaWikiVersionError`` is raised. 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 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 `version 0.6.5 <//github.com/btongminh/mwclient/archive/REL_0_6_5.zip>`_ on 6 May 2011.
installed directly off github: The current `development version <//github.com/btongminh/mwclient>`_
can be installed directly off github:
.. code-block:: console .. code-block:: console
$ pip install git+git://github.com/btongminh/mwclient.git $ pip install git+git://github.com/btongminh/mwclient.git
Please see `release notes`_ for a list of changes. Please see the `release notes <//github.com/btongminh/mwclient/blob/master/RELEASE-NOTES.md>`_
for a list of changes.
Implementation notes Implementation notes
-------------------- --------------------
Most properties and generators accept the same parameters as the API, without Most properties and generators accept the same parameters as the API,
their two letter prefix. Exceptions to this rule: without their two-letter prefix. Exceptions to this rule:
* ``Image.imageinfo`` is the imageinfo of the latest image. Earlier versions can be * ``Image.imageinfo`` is the imageinfo of the latest image.
fetched using ``imagehistory()`` Earlier versions can be fetched using ``imagehistory()``
* ``Site.all*``: parameter ``[ap]from`` renamed to ``start`` * ``Site.all*``: parameter ``[ap]from`` renamed to ``start``
* ``categorymembers`` is implemented as ``Category.members`` * ``categorymembers`` is implemented as ``Category.members``
* ``deletedrevs`` is ``deletedrevisions`` * ``deletedrevs`` is ``deletedrevisions``
...@@ -48,7 +51,8 @@ To use https, specify the host as a tuple in the form of ``('https', hostname)`` ...@@ -48,7 +51,8 @@ To use https, specify the host as a tuple in the form of ``('https', hostname)``
Example Example
------- -------
For more information, see `REFERENCE.md <REFERENCE.md>`_. For more information, see the
`REFERENCE.md <//github.com/btongminh/mwclient/blob/master/REFERENCE.md>`_ file.
.. code-block:: python .. code-block:: python
...@@ -76,10 +80,3 @@ For more information, see `REFERENCE.md <REFERENCE.md>`_. ...@@ -76,10 +80,3 @@ For more information, see `REFERENCE.md <REFERENCE.md>`_.
# Listing all categories (don't do this in reality) # Listing all categories (don't do this in reality)
for category in site.allcategories(): for category in site.allcategories():
print category 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
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment