Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Pywikibot 10.1.0.dev0 documentation
Logo
Pywikibot 10.1.0.dev0 documentation
previous next modules index

User guide

  • Introduction
  • Framework utility scripts
  • Scripts package
    • Global bot scripts
    • Main bot scripts
    • Auxiliary scripts
    • Administrative scripts
    • General pages changes scripts
    • Categories scripts
    • Images scripts
    • Template scripts
    • Wikibase scripts
    • Non editing scripts
    • Other bot scripts
    • Unsorted scripts
    • Utility scripts
    • Outdated core scripts
    • Outdated compat scripts
  • Global options
  • Frequently asked questions
  • Getting help

Bot developer guide

  • Using pywikibot as library
  • Recipes
  • API reference
    • pywikibot — Base Classes and Functions
    • config — Pywikibot Config File
    • page — MediaWiki Pages
    • proofreadpage — ProofreadPage Extension
    • pagegenerators — Page Generators
    • site — MediaWiki sites
    • login module
    • logentries module
    • family — MediaWiki families
    • families — Family Config Files
    • data — Data Exchange
    • comms — Communication layer
    • exceptions — Exceptions and Warning Classes
    • textlib — Changing Wikitext
    • cosmetic_changes — Cosmetic Changes of Wikitext
    • bot — Classes for Building Bots
    • specialbots — Special Reusable Bots
    • bot_choice — UI Options and Choices
    • userinterfaces — User interfaces
    • logging — Logging Functions
    • daemonize — Daemonize Current Process (Unix only)
    • date — Date Classes and Functions
    • time — Time Classes and Functions
    • diff — Helpers for computing deltas
    • echo — Echo Extension Classes and functions
    • editor — Text editor class
    • fixes — standard fixes for replace.py script
    • i18n — i18n Support
    • plural — i18n Plural rules
    • interwiki_graph — Graphviz Drawing for Interwiki
    • titletranslate — Interwiki Title Translator
    • xmlreader — XML Reader
    • site_detect — Classes for Detecting MediaWiki Sites
    • throttle — Slow Down Wiki I/O
    • version — Determine Pywikibot Version
    • backports — Python Backports
    • tools — Miscellaneous Helper Functions
    • tools.chars — Character Based Helper Functions
    • tools.collections — Container datatypes
    • tools.djvu — DJVU files wrapper
    • tools.formatter — Formatting Related Functions and Classes
    • tools.itertools — Iterators for Efficient Looping
    • tools.threading — Thread-based Classes
  • MediaWiki API cross reference
  • Provide your own scripts

Pywikibot contributor guide

  • Framework utility scripts reference
  • Scripts reference
    • Scripts package
    • Translation files - scripts.i18n
    • Maintenance scripts
    • User scripts - scripts.userscripts
  • Installer scripts
  • Tests reference
    • tests.aspects module
    • tests.basepage module
    • tests.utils module

About

  • Change log
  • Version compatibility
  • Licenses
  • Credits
  • Glossary
Back to top
View this page
Edit this page

Getting help#

Note

For information on how to connect with Pywikibot developers and users, see Communication.

Tip

Please report bugs in Phabricator. You can use this report form.

Next
Using pywikibot as library
Previous
Frequently asked questions
Copyright © 2003-2025, Pywikibot team
Made with Sphinx and @pradyunsg's Furo