Metadata-Version: 2.4
Name: pywikibot
Version: 10.2.0
Summary: Python MediaWiki Bot Framework
Author-email: xqt <info@gno.de>
Maintainer-email: The Pywikibot team <pywikibot@lists.wikimedia.org>
License: MIT License
Project-URL: Homepage, https://www.mediawiki.org/wiki/Manual:Pywikibot
Project-URL: Documentation, https://doc.wikimedia.org/pywikibot/stable/
Project-URL: Repository, https://gerrit.wikimedia.org/r/plugins/gitiles/pywikibot/core/
Project-URL: GitHub Mirror, https://github.com/wikimedia/pywikibot
Project-URL: Download, https://www.pywikibot.org
Project-URL: Changelog, https://doc.wikimedia.org/pywikibot/master/changelog.html
Project-URL: Tracker, https://phabricator.wikimedia.org/tag/pywikibot/
Keywords: API,bot,client,framework,mediawiki,pwb,pybot,python,pywiki,pywikibase,pywikibot,pywikipedia,pywikipediabot,wiki,wikibase,wikidata,wikimedia,wikipedia
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: Afrikaans
Classifier: Natural Language :: Arabic
Classifier: Natural Language :: Basque
Classifier: Natural Language :: Bengali
Classifier: Natural Language :: Bosnian
Classifier: Natural Language :: Bulgarian
Classifier: Natural Language :: Cantonese
Classifier: Natural Language :: Catalan
Classifier: Natural Language :: Chinese (Simplified)
Classifier: Natural Language :: Chinese (Traditional)
Classifier: Natural Language :: Croatian
Classifier: Natural Language :: Czech
Classifier: Natural Language :: Danish
Classifier: Natural Language :: Dutch
Classifier: Natural Language :: English
Classifier: Natural Language :: Esperanto
Classifier: Natural Language :: Finnish
Classifier: Natural Language :: French
Classifier: Natural Language :: Galician
Classifier: Natural Language :: German
Classifier: Natural Language :: Greek
Classifier: Natural Language :: Hebrew
Classifier: Natural Language :: Hindi
Classifier: Natural Language :: Hungarian
Classifier: Natural Language :: Icelandic
Classifier: Natural Language :: Indonesian
Classifier: Natural Language :: Irish
Classifier: Natural Language :: Italian
Classifier: Natural Language :: Japanese
Classifier: Natural Language :: Javanese
Classifier: Natural Language :: Korean
Classifier: Natural Language :: Latin
Classifier: Natural Language :: Latvian
Classifier: Natural Language :: Lithuanian
Classifier: Natural Language :: Macedonian
Classifier: Natural Language :: Malay
Classifier: Natural Language :: Marathi
Classifier: Natural Language :: Nepali
Classifier: Natural Language :: Norwegian
Classifier: Natural Language :: Panjabi
Classifier: Natural Language :: Persian
Classifier: Natural Language :: Polish
Classifier: Natural Language :: Portuguese
Classifier: Natural Language :: Portuguese (Brazilian)
Classifier: Natural Language :: Romanian
Classifier: Natural Language :: Russian
Classifier: Natural Language :: Serbian
Classifier: Natural Language :: Slovak
Classifier: Natural Language :: Slovenian
Classifier: Natural Language :: Spanish
Classifier: Natural Language :: Swedish
Classifier: Natural Language :: Tamil
Classifier: Natural Language :: Telugu
Classifier: Natural Language :: Thai
Classifier: Natural Language :: Tibetan
Classifier: Natural Language :: Turkish
Classifier: Natural Language :: Ukrainian
Classifier: Natural Language :: Urdu
Classifier: Natural Language :: Vietnamese
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content :: Wiki
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Requires-Python: >=3.8.0
Description-Content-Type: text/x-rst
License-File: LICENSE
License-File: AUTHORS.rst
Requires-Dist: mwparserfromhell>=0.5.2
Requires-Dist: packaging
Requires-Dist: requests>=2.31.0
Provides-Extra: eventstreams
Requires-Dist: requests-sse>=0.5.0; extra == "eventstreams"
Provides-Extra: isbn
Requires-Dist: python-stdnum>=1.20; extra == "isbn"
Provides-Extra: graphviz
Requires-Dist: pydot>=3.0.2; extra == "graphviz"
Provides-Extra: google
Requires-Dist: googlesearch-python>=1.3.0; extra == "google"
Provides-Extra: memento
Requires-Dist: memento_client==0.6.1; extra == "memento"
Provides-Extra: wikitextparser
Requires-Dist: wikitextparser>=0.56.3; extra == "wikitextparser"
Provides-Extra: mysql
Requires-Dist: PyMySQL>=1.1.1; extra == "mysql"
Provides-Extra: tkinter
Requires-Dist: Pillow>=11.1.0; python_version > "3.8" and extra == "tkinter"
Requires-Dist: Pillow==10.4.0; python_version < "3.9" and extra == "tkinter"
Provides-Extra: mwoauth
Requires-Dist: PyJWT!=2.10.0,!=2.10.1; python_version > "3.8" and extra == "mwoauth"
Requires-Dist: mwoauth!=0.3.1,>=0.2.4; extra == "mwoauth"
Provides-Extra: html
Requires-Dist: beautifulsoup4>=4.7.1; extra == "html"
Provides-Extra: http
Requires-Dist: fake-useragent>=2.0.3; python_version > "3.8" and extra == "http"
Requires-Dist: fake-useragent==1.5.1; python_version < "3.9" and extra == "http"
Provides-Extra: create-isbn-edition-py
Requires-Dist: isbnlib; extra == "create-isbn-edition-py"
Requires-Dist: unidecode; extra == "create-isbn-edition-py"
Provides-Extra: weblinkchecker-py
Requires-Dist: memento_client==0.6.1; extra == "weblinkchecker-py"
Provides-Extra: scripts
Requires-Dist: isbnlib; extra == "scripts"
Requires-Dist: unidecode; extra == "scripts"
Requires-Dist: memento_client==0.6.1; extra == "scripts"
Dynamic: description
Dynamic: description-content-type
Dynamic: license-file
Dynamic: provides-extra
Dynamic: requires-dist

.. image:: https://github.com/wikimedia/pywikibot/actions/workflows/pywikibot-ci.yml/badge.svg?branch=master
   :alt: GitHub CI
   :target: https://github.com/wikimedia/pywikibot/actions/workflows/pywikibot-ci.yml
.. image:: https://codecov.io/gh/wikimedia/pywikibot/branch/master/graph/badge.svg
   :alt: Code coverage
   :target: https://app.codecov.io/gh/wikimedia/pywikibot
.. image:: https://img.shields.io/pypi/pyversions/pywikibot.svg
   :alt: Python
   :target: https://www.python.org/downloads/
.. image:: https://img.shields.io/github/languages/top/wikimedia/pywikibot
   :alt: Top language
   :target: https://www.python.org/downloads/
.. image:: https://img.shields.io/pypi/v/pywikibot.svg
   :alt: Pywikibot release
   :target: https://pypi.org/project/pywikibot/
.. image:: https://img.shields.io/pypi/wheel/pywikibot
   :alt: wheel
   :target: https://pypi.org/project/pywikibot/
.. image:: https://static.pepy.tech/badge/pywikibot
   :alt: Total downloads
   :target: https://pepy.tech/project/pywikibot
.. image:: https://static.pepy.tech/personalized-badge/pywikibot?period=month&units=international_system&left_color=black&right_color=blue&left_text=monthly
   :alt: Monthly downloads
   :target: https://pepy.tech/project/pywikibot
.. image:: https://img.shields.io/github/last-commit/wikimedia/pywikibot
   :alt: Last commit
   :target: https://gerrit.wikimedia.org/r/plugins/gitiles/pywikibot/core/
.. image:: https://snyk.io/advisor/python/pywikibot/badge.svg
   :target: https://snyk.io/advisor/python/pywikibot
   :alt: pywikibot


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

The Pywikibot framework is a Python library that interfaces with the
`MediaWiki API <https://www.mediawiki.org/wiki/API:Main_page>`_
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 <https://doc.wikimedia.org/pywikibot/stable/>`_.

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 <https://www.mediawiki.org/wiki/Manual:Pywikibot/Installation>`_
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:
            opt, sep, value = arg.partition(':')
            if opt in ('-summary', '-text'):
                options[opt[1:]] = value
        MyBot(generator=gen_factory.getCombinedGenerator(), **options).run()

    if __name == '__main__':
        main()


For more documentation on Pywikibot see our `docs <https://doc.wikimedia.org/pywikibot/>`_.


Roadmap
=======

Current Release Changes
=======================

* Use Lock object in comms.http.PywikibotCookieJarfor thread-safe saving (T396309)
* Raise TypeError instead of ValueError in i18n.translateif *parameter* is not a mapping
* Recognise wildcard in config.usernameswhen running
  loginscript (T110411)
* Search for http and https by default in Site.exturlusage()
  (T396280)
* Add login methods overview to loginmodule (T396204)
* Enable EmailAuth with login.ClientLoginManager(T395703)
* Move tools.threading.RLockto backportsmodule (T395182)
* Only show the description passed to specialbots.UploadRobotif it is to be verified (T394895)
* Add support for Python 3.15 (T395177)


Current Deprecations
====================

* 10.0.0: 'millenia' argument for *precision* parameter of pywikibot.WbTimeis deprecated;
  'millennium' must be used instead.
* 10.0.0: *includeredirects* parameter of pagegenerators.AllpagesPageGeneratorand
  pagegenerators.PrefixingPageGeneratoris deprecated and should be replaced by *filterredir*
* 9.6.0: BaseSite.languages()will be removed in favour of
  BaseSite.codes
* 9.5.0: DataSite.getPropertyType()will be removed
  in favour of DataSite.get_property_type()
* 9.3.0: page.BasePage.userNameand page.BasePage.isIpEditare deprecated in favour of
  ``user`` or ``anon`` attributes of page.BasePage.latest_revisionproperty
* 9.2.0: Imports of loggingfunctions from botmodule is deprecated and will be desupported
* 9.2.0: *total* argument in ``-logevents`` pagegenerators option is deprecated;
  use ``-limit`` instead (T128981)
* 9.0.0: The *content* parameter of proofreadpage.IndexPage.page_genis deprecated and will be ignored
  (T358635)
* 9.0.0: ``userinterfaces.transliteration.transliterator`` was renamed to Transliterator
  
* 9.0.0: ``next`` parameter of userinterfaces.transliteration.transliterator.transliteratewas renamed to
  ``succ``
* 9.0.0: ``type`` parameter of site.APISite.protectedpages()
  was renamed to ``protect_type``
* 9.0.0: ``all`` parameter of site.APISite.namespace()was renamed to
  ``all_ns``
* 9.0.0: ``filter`` parameter of date.dhwas renamed to ``filter_func``
* 9.0.0: ``dict`` parameter of data.api.OptionSetwas renamed to ``data``
* 9.0.0: ``pywikibot.version.get_toolforge_hostname()`` is deprecated without replacement
* 9.0.0: ``allrevisions`` parameter of xmlreader.XmpDumpis deprecated, use ``revisions`` instead
  (T340804)
* 9.0.0: ``iteritems`` method of data.api.Requestwill be removed in favour of ``items``
* 9.0.0: ``SequenceOutputter.output()`` is deprecated in favour of tools.formatter.SequenceOutputter.out
  property


Pending removal in Pywikibot 11
-------------------------------

* 8.4.0: *modules_only_mode* parameter of data.api.ParamInfo, its *paraminfo_keys* class attribute
  and its preloaded_modules property will be removed
* 8.4.0: *dropdelay* and *releasepid* attributes of throttle.Throttlewill be removed
  in favour of *expiry* class attribute
* 8.2.0: tools.itertools.itergroupwill be removed in favour of backports.batched
* 8.2.0: *normalize* parameter of WbTime.toTimestrand WbTime.toWikibasewill be removed
* 8.1.0: Dependency of exceptions.NoSiteLinkErrorfrom exceptions.NoPageErrorwill be removed
* 8.1.0: ``exceptions.Server414Error`` is deprecated in favour of exceptions.Client414Error
* 8.0.0: Timestamp.clone()method is deprecated
  in favour of ``Timestamp.replace()`` method.
* 8.0.0: family.Family.maximum_GET_lengthmethod is deprecated in favour of
  config.maximum_GET_length(T325957)
* 8.0.0: ``addOnly`` parameter of textlib.replaceLanguageLinksand
  textlib.replaceCategoryLinksare deprecated in favour of ``add_only``
* 8.0.0: textlib.TimeStripperregex attributes ``ptimeR``, ``ptimeznR``, ``pyearR``, ``pmonthR``,
  ``pdayR`` are deprecated in favour of ``patterns`` attribute which is a
  textlib.TimeStripperPatterns.
* 8.0.0: textlib.TimeStripper``groups`` attribute is deprecated in favour of ``textlib.TIMEGROUPS``
* 8.0.0: LoginManager.get_login_tokenwas
  replaced by ``login.ClientLoginManager.site.tokens['login']``
* 8.0.0: ``data.api.LoginManager()`` is deprecated in favour of login.ClientLoginManager
* 8.0.0: APISite.messages()method is deprecated in favour of
  userinfo['messages']
* 8.0.0: Page.editTime()method is deprecated and should be replaced by
  Page.latest_revision.timestamp

Release history
===============

See https://github.com/wikimedia/pywikibot/blob/stable/HISTORY.rst

Contributing
============

Our code is maintained on Wikimedia's `Gerrit installation <https://gerrit.wikimedia.org/>`_,
`learn <https://www.mediawiki.org/wiki/Developer_account>`_ how to get
started.

Code of Conduct
===============

The development of this software is covered by a
`Code of Conduct <https://www.mediawiki.org/wiki/Special:MyLanguage/Code_of_Conduct>`_.
