Python MediaWiki Bot Framework
Project description
Pywikibot
The Pywikibot framework is a Python library that interfaces with the MediaWiki API version 1.14 or higher.
Also included are various general function scripts that can be adapted for different tasks.
For further information about the library excluding scripts see the full code documentation.
Quick start
git clone https://gerrit.wikimedia.org/r/pywikibot/core.git cd core git submodule update --init python pwb.py script_name
Or to install using PyPI (excluding scripts)
pip install pywikibot --pre
Our installation guide has more details for advanced usage.
Basic Usage
If you wish to write your own script it’s very easy to get started:
import pywikibot
site = pywikibot.Site('en', 'wikipedia') # The site we want to run our bot on
page = pywikibot.Page(site, 'Wikipedia:Sandbox')
page.text = page.text.replace('foo', 'bar')
page.save('Replacing "foo" with "bar"') # Saves the page
For more documentation on pywikibot see our docs.
The contents of the package
Directories
pywikibot
Library routines, control files and global settings
pywikibot/comms
Communication layer
pywikibot/compat
Package to provide compatibility with compat scripts
pywikibot/data
Module with several layers for data access to wiki
pywikibot/families
wiki-specific information and settings
pywikibot/tools
Miscellaneous helper functions (not wiki-dependent)
pywikibot/userinterfaces
GUI and terminal interface
Required external programs
It may require the following programs to function properly:
7za: To extract 7z files
Release history
Current release
Introduce userscripts directory
Generator settings inside (user-)fixes.py
BaseUnlinkBot has become part of the framework in specialbots.py
Decommission of rcstream
Script files added to https://doc.wikimedia.org/pywikibot/
Other documentation updates
Bugfixes and improvements
Localisation updates
3.0.20170801
Bugfixes and improvements
Localisation updates
3.0.20170713
Implement server side event client EventStreams
Add thanks log support
new ndashredir.py script to create hyphenated redirects
new followlive.py script to flag new articles
new WbUnknown data type for Wikibase
Deprecate APISite.newfiles()
new pagegenerators filter option -titleregexnot
Inverse of pagegenerators -namespace option
Bugfixes and improvements
Localisation updates
Remove panoramiopicker.py script
Remove anarchopedia family out of the framework
CODE_OF_CONDUCT included
3.0.20170521
Replaced the word ‘async’ with ‘asynchronous’ due to python 3.7
Support for Python 2.6 but higher releases are strictly recommended
Bugfixes and improvements
Localisation updates
3.0.20170403
First major release from master branch
requests package is mandatory
Deprecate previous 2.0 branches
2.0rc5
Last stable 2.0 branch
2.0rc4
Remove dependency on pYsearch
Desupport Python 2.6 for Pywikibot 2.0 release branch
2.0rc3
Bugfixes
Localisation updates
i18n: always follow master branch
2.0rc2
Bugfixes and improvements
Localisation updates
2.0rc1
New scripts patrol.py and piper.py ported from old compat branch
isbn.py now supports wikibase
RecentChanges stream (rcstream) support
Sphinx documentation at https://doc.wikimedia.org/pywikibot/
Bugfixes and improvements
Localisation updates
2.0b3
Bugfixes and improvements
2.0b2
Bugfixes and improvements
2.0b1
First stable release branch
Contributing
Our code is maintained on Wikimedia’s Gerrit installation, learn how to get started.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file pywikibot-3.0.20171212.tar.gz.
File metadata
- Download URL: pywikibot-3.0.20171212.tar.gz
- Upload date:
- Size: 485.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 6f5cb522b566380d8492a6dbf920114670fdd621aa5c7cc7a090dde44ac186bc |
|
| MD5 | 84aad9dc65559c8c29734f351c7b8c85 |
|
| BLAKE2b-256 | 42b9c5c4cd227d61142d1e2ce26d10188bb5f217cbe7b3c5153cbaacd037c23b |
