Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
M
mwclient
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
WebU
shared
mwclient
Commits
fd7d3838
Commit
fd7d3838
authored
11 years ago
by
Dan Michael O. Heggø
Browse files
Options
Downloads
Plain Diff
Merge branch 'master' of
git://github.com/btongminh/mwclient
into iwlinks
parents
6c0ef3d7
2f2d2f91
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.rst
+16
-19
16 additions, 19 deletions
README.rst
with
16 additions
and
19 deletions
README.rst
+
16
−
19
View file @
fd7d3838
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
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment