Manual:Pywikibot/Overview

Pywikibot
Quick overview Installation Running on PAWS Running on Windows Running on Toolforge Configuration and scripts user-config.py Global options Generator and filter options i18n Scripts Uses Cookbook Wikidata Non-Wikimedia wikis Development Further help More... »

Pywikibot is a Python library and collection of tools that automate work on MediaWiki sites. Originally designed for Wikipedia, it is now used throughout the Wikimedia Foundation's projects and on many other MediaWiki wikis.

The project started in 2003 and is currently on core version 9.5.0. It features full API usage and is up-to-date with new MediaWiki features and a Pythonic package layout. But it also works with older installations of MediaWiki 1.27 or higher.

Pywikibot supports Microsoft Windows, macOS and Linux when used with a compatible version of Python. It should also work on any other operating system that has a compatible version of Python installed. To check whether you have Python installed and to find its version, just type "python" at the CMD or shell prompt.

Python 3.7 or higher is currently required to run the bot.

Python can be downloaded here.

Download

$ python -m pip install pywikibot

For more information, see here.

Components

Two master folders are present in the library archive:

• pywikibot contains all the master files, that will interact with MediaWiki websites. It's the master part of the library: they're used when you load PWB in your own Python scripts and when you launch plug-and-play tools.
• scripts contains already written, known and proven scripts. They are ready to be used. See the list and docs for each one in Manual:Pywikibot/Scripts .

See also

• Manual:Pywikibot/Workshop Materials/How to run basic scripts (self-study)

License

Here you can view the LICENSE files for Pywikibot.