Metadata-Version: 2.0
Name: pywikibot
Version: 2.0rc5
Summary: Python MediaWiki Bot Framework
Home-page: https://www.mediawiki.org/wiki/Pywikibot
Author: The Pywikibot team
Author-email: pywikibot@lists.wikimedia.org
License: MIT License
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Development Status :: 4 - Beta
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: Environment :: Console
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Requires-Dist: httplib2 (>=0.9)
Provides-Extra: Google
Requires-Dist: google (>=1.7); extra == 'Google'
Provides-Extra: Graphviz
Requires-Dist: pydot (>=1.0.28); extra == 'Graphviz'
Provides-Extra: IRC
Requires-Dist: irc; extra == 'IRC'
Provides-Extra: Tkinter
Requires-Dist: Pillow; extra == 'Tkinter'
Provides-Extra: flickrripper.py
Requires-Dist: Pillow; extra == 'flickrripper.py'
Requires-Dist: flickrapi; extra == 'flickrripper.py'
Provides-Extra: isbn
Requires-Dist: python-stdnum; extra == 'isbn'
Provides-Extra: mwparserfromhell
Requires-Dist: mwparserfromhell (>=0.3.3); extra == 'mwparserfromhell'
Provides-Extra: rcstream
Requires-Dist: socketIO-client (<0.6.1); extra == 'rcstream'
Provides-Extra: script_wui.py
Requires-Dist: crontab; extra == 'script_wui.py'
Requires-Dist: irc; extra == 'script_wui.py'
Requires-Dist: lunatic-python; extra == 'script_wui.py'
Provides-Extra: states_redirect.py
Requires-Dist: pycountry; extra == 'states_redirect.py'

Pywikibot
=========

The Pywikibot framework is a Python library that interfaces with the
`MediaWiki API <https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page>`_
version 1.14 or higher.

Also included are various general function scripts that can be adapted for
different tasks.

Quick start
-----------

::

    git clone https://gerrit.wikimedia.org/r/pywikibot/core.git
    cd core
    git submodule update --init
    python pwb.py script_name

Our `installation
guide <https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Pywikibot/Installation>`_
has more details for advanced usage.

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

Required external programms
---------------------------

It may require the following programs to function properly:

* `7za`: To extract 7z files

Contributing
------------

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

.. image:: https://secure.travis-ci.org/wikimedia/pywikibot-core.png?branch=master
   :alt: Build Status
   :target: https://travis-ci.org/wikimedia/pywikibot-core


