Manual:Pywikibot/Overview
 |
| Pywikibot |
|---|
|
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 2002 and is currently on version 2.0rc4.
Which Pywikibot should you use? The better choice is the core release of Pywikibot, formerly known as the rewrite branch. It features several improvements, such as full API usage, and is much more up-to-date with new MediaWiki features and a Pythonic package layout. It works with installations of MediaWiki 1.14 or higher.
There is also a compat release (formerly 'trunk') available, which is old and largely based on screen-scraping. It supports older versions of MediaWiki but not higher than MediaWiki 1.27.
The Pywikibot community strongly recommends that you use core instead of compat. The table below may assist in choosing between the compat and core releases.
Requirements for a bot
Pywikibot supports Microsoft Windows, OS X 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. See the table below to determine if a compatible version of Python has been installed.
| Pywikibot branch | ||||
|---|---|---|---|---|
| master 9.4.0 |
stable 9.3.1 |
python2 3.0.20200703 | ||
| Deployed | August 2024 | |||
| Comment | Current branch for developing and testing. Use it on your own risks but any bug reports are welcomed. | Stable branch for production systems; updated monthly after passing unit tests. | Stable branch for production systems running in Python 2 environment. No longer updated; does not support current Wikimedia sites any longer. | |
| MediaWiki version supported | 1.27–1.43 | 1.27–1.42 | 1.14–1.35 | |
| Python version | ||||
| <= 2.7.3 | no support | no support | ||
| 2.7.4 – 2.7.18 | OK *) | |||
| 3.0 – 3.3 | no support | |||
| 3.4 – 3.5 | OK *) | |||
| 3.6.0 – 3.6.15 | OK | |||
| 3.7.0 – 3.8.5 | OK | |||
| 3.8.6 – 3.13, PyPy | OK | no support | ||
License
Here you can view the LICENSE files for core and compat.
Other licenses
- pywikibot/userinterfaces/win32_unicode.py is based on code that is CC BY-SA 3.0.
- pywikibot/backports.py consists of code from PSF, and is licensed PSF 2.0.
[[Category:PywikibotTemplate:Translation|Overview]]