MediaWiki
*mediawiki* is a python wrapper and parser for the MediaWiki API. The goal is to allow users to quickly and efficiently pull data from the MediaWiki site of their choice instead of worrying about dealing directly with the API. As such, it does not force the use of a particular MediaWiki site. It defaults to Wikipedia but other MediaWiki sites can also be used.
MediaWiki wraps the MediaWiki API so you can focus on leveraging your favorite MediaWiki site’s data, not getting it. Please check out the code on github!
Note: this library was designed for ease of use and simplicity. If you plan on doing serious scraping, automated requests, or editing, please look into Pywikibot which has a larger API, advanced rate limiting, and other features so we may be considerate of the MediaWiki infrastructure. Pywikibot has also other extra features such as support for Wikibase (that runs Wikidata).
Installation
Pip Installation:
$ pip install pymediawiki
To install from source:
To install mediawiki, simply clone the repository on GitHub, then run from the folder:
$ python setup.py install
mediawiki supports python versions 3.7 - 3.13
For python 2.7 support, install release 0.6.7
$ pip install pymediawiki==0.6.7
Documentation
Documentation of the latest release is hosted on readthedocs.io
To build the documentation yourself run:
$ pip install sphinx $ cd docs/ $ make html
Automated Tests
To run automated tests, one must simply run the following command from the downloaded folder:
$ python setup.py test
Quickstart
Import mediawiki and run a standard search against Wikipedia:
>>> from mediawiki import MediaWiki
>>> wikipedia = MediaWiki()
>>> wikipedia.search('washington')Run more advanced searches:
>>> wikipedia.opensearch('washington')
>>> wikipedia.allpages('a')
>>> wikipedia.geosearch(title='washington, d.c.')
>>> wikipedia.geosearch(latitude='0.0', longitude='0.0')
>>> wikipedia.prefixsearch('arm')
>>> wikipedia.random(pages=10)Pull a MediaWiki page and some of the page properties:
>>> p = wikipedia.page('Chess')
>>> p.title
>>> p.summary
>>> p.categories
>>> p.images
>>> p.links
>>> p.langlinksSee the documentation for more examples!
Changelog
Please see the changelog for a list of all changes.
License
MIT licensed. See the LICENSE file for full details.
1 maintainer
Metadata
1 maintainer
Release files for pymediawiki 0.7.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pymediawiki-0.7.5.tar.gz | 1.7 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pymediawiki-0.7.5-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.7 MB
Release files / pymediawiki-0.7.5.tar.gz
| Download URL | pymediawiki-0.7.5.tar.gz |
|---|---|
| Size | 1.7 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6d17c1bf9750110c2dc2203f82cdda209f3e84ed32443356942f3eb5c8a0ec25
|
|
BLAKE2b-256 checksum How to use checksums |
fc4eeec5f39d2ed22d10c6580be5ed54b99e867a20057815d62a0f3809a6ca4a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.0.1 CPython/3.12.8
|
Release files / pymediawiki-0.7.5-py3-none-any.whl
| Download URL | pymediawiki-0.7.5-py3-none-any.whl |
|---|---|
| Size | 27.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
78642bd95c470246ed48598958a1eb30c5c51245f5767f4cad1bf4dcfde75511
|
|
BLAKE2b-256 checksum How to use checksums |
128f9d3637ee30759a19908b81b6123161d16f637daab7dc4e3a8f791ea56232
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.0.1 CPython/3.12.8
|
