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

NAMEBASE=		python-pywikibot
VERSION=		10.7.6
KEYWORDS=		python
VARIANTS=		v13 v14
SDESC[v13]=		Python MediaWiki Bot Framework (3.13)
SDESC[v14]=		Python MediaWiki Bot Framework (3.14)
HOMEPAGE=		https://www.mediawiki.org/wiki/Manual:Pywikibot
CONTACT=		Python_Automaton[python@ironwolf.systems]

DOWNLOAD_GROUPS=	main
SITES[main]=		PYPIWHL/11/b6/78608caf38b07146f1e8b8fd7cc69a310ab1e3290ec603cf5d88dd6caff0
DISTFILE[1]=		pywikibot-10.7.6-py3-none-any.whl:main
DIST_SUBDIR=		python-src
DF_INDEX=		1
SPKGS[v13]=		single
SPKGS[v14]=		single

OPTIONS_AVAILABLE=	PY313 PY314
OPTIONS_STANDARD=	none
VOPTS[v13]=		PY313=ON PY314=OFF
VOPTS[v14]=		PY313=OFF PY314=ON

DISTNAME=		pywikibot-10.7.6.dist-info

GENERATED=		yes

[PY313].RUN_DEPENDS_ON=			python-mwparserfromhell:single:v13
					python-packaging:single:v13
					python-requests:single:v13
[PY313].USES_ON=			python:v13,wheel

[PY314].RUN_DEPENDS_ON=			python-mwparserfromhell:single:v14
					python-packaging:single:v14
					python-requests:single:v14
[PY314].USES_ON=			python:v14,wheel

[FILE:2631:descriptions/desc.single]
   :alt: pywikibot

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

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


[FILE:123:distinfo]
47dff243b5a74f292cd38261670156d036b6566338315d9eb4393ed78bc3f9de       739716 python-src/pywikibot-10.7.6-py3-none-any.whl