# Buildsheet autogenerated by ravenadm tool -- Do not edit.

NAMEBASE=		python-pywikibot
VERSION=		9.1.2
KEYWORDS=		python
VARIANTS=		v11 v12
SDESC[v11]=		Python MediaWiki Bot Framework (3.11)
SDESC[v12]=		Python MediaWiki Bot Framework (3.12)
HOMEPAGE=		https://www.mediawiki.org/wiki/Manual:Pywikibot
CONTACT=		Python_Automaton[python@ironwolf.systems]

DOWNLOAD_GROUPS=	main
SITES[main]=		PYPIWHL/17/13/8b5b9ae77099b5807ba78889caa53f991508293c268cd22e585ab97bda2e
DISTFILE[1]=		pywikibot-9.1.2-py3-none-any.whl:main
DF_INDEX=		1
SPKGS[v11]=		single
SPKGS[v12]=		single

OPTIONS_AVAILABLE=	PY311 PY312
OPTIONS_STANDARD=	none
VOPTS[v11]=		PY311=ON PY312=OFF
VOPTS[v12]=		PY311=OFF PY312=ON

DISTNAME=		pywikibot-9.1.2.dist-info

GENERATED=		yes

[PY311].RUN_DEPENDS_ON=			python-mwparserfromhell:single:v11
					python-packaging:single:v11
					python-requests:single:v11
[PY311].USES_ON=			python:v11,wheel

[PY312].RUN_DEPENDS_ON=			python-mwparserfromhell:single:v12
					python-packaging:single:v12
					python-requests:single:v12
[PY312].USES_ON=			python:v12,wheel

[FILE:2643:descriptions/desc.single]

*********
Pywikibot
*********

The Pywikibot framework is a Python library that interfaces with the
[MediaWiki API]
version 1.27 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
===========

.. code:: text

    git clone https://gerrit.wikimedia.org/r/pywikibot/core.git
    cd core
    git submodule update --init
    pip install -r requirements.txt
    python pwb.py <script_name>

Or to install using PyPI (excluding scripts)

.. code:: text

    pip install pywikibot
    pwb <scriptname>

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:

.. code:: python

    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

Wikibase Usage
==============

Wikibase is a flexible knowledge base software that drives Wikidata.
A sample pywikibot script for getting data from Wikibase:

.. code:: python

    import pywikibot
    site = pywikibot.Site('wikipedia:en')
    repo = site.data_repository()  # the Wikibase repository for given site
    page = repo.page_from_repository('Q91')  # create a local page for the
given item
    item = pywikibot.ItemPage(repo, 'Q91')  # a repository item
    data = item.get()  # get all item data from repository for this item

Script example
==============

Pywikibot provides bot classes to develop your own script easily:

.. code:: python

    import pywikibot
    from pywikibot import pagegenerators
    from pywikibot.bot import ExistingPageBot

    class MyBot(ExistingPageBot):

        update_options = {
            'text': 'This is a test text',
            'summary': 'Bot: a bot test edit with Pywikibot.'
        }

        def treat_page(self):
            """Load the given page, do some changes, and save it."""
            text = self.current_page.text
            text += '\n' + self.opt.text
            self.put_current(text, summary=self.opt.summary)

    def main():
        """Parse command line arguments and invoke bot."""
        options = {}
        gen_factory = pagegenerators.GeneratorFactory()
        # Option parsing
        local_args = pywikibot.handle_args(args)  # global options
        local_args = gen_factory.handle_args(local_args)  # generators
options
        for arg in local_args:


[FILE:111:distinfo]
d200d581f9dbeb7902f0fb35c22034c5ea26f294f13870d24ed7293b717f78ac       713638 pywikibot-9.1.2-py3-none-any.whl