pyWikiCommons

Python package for downloading images and videos from Wikimedia Commons using the Wikimedia API (https://commons.wikimedia.org/w/api.php).

Table of Contents

• Introduction
• Requirements
• Installation
• Usage
• Directory Folders
• Tests
• Issues
• Contact
• References

Introduction

https://www.mediawiki.org/wiki/API:Main_page

Requirements

• Python >= 3.6
• requests >= 2.25.0

Installation

Install the latest version of pyWikiCommons using pip:

pip3 install pyWikiCommons

Installation from source:

git clone -b master https://github.com/amckenna41/pyWikiCommons.git
python3 setup.py install
cd pyWikiCommons

Usage

https://www.mediawiki.org/wiki/API:Main_page

Directories

• /docs - documentation for pyWikiCommons (pending).
• /images - all images used throughout the repo.
• /pyWikiCommons - source code for pyWikiCommons software.
• /tests - unit and integration tests for pyWikiCommons.

Issues

Any issues, errors or bugs can be raised via the Issues tab in the repository.

Tests

To run all tests, from the main pyWikiCommons repo folder run:

python3 -m unittest discover

To run tests for specific module, from the main pyWikiCommons repo folder run:

python -m unittest tests.MODULE_NAME -v

License

Distributed under the MIT License. See LICENSE for more details.

Contact

If you have any questions or comments, please contact amckenna41@qub.ac.uk or raise an issue on the Issues tab.

References

[1]: https://www.mediawiki.org/wiki/API:Main_page
[2]: https://commons.wikimedia.org/w/api.php

Back to top