Metadata-Version: 1.1
Name: pywikibot
Version: 3.0.20170521
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
Description: 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.
        
        For further information about the library excluding scripts see
        the full `code documentation <https://doc.wikimedia.org/pywikibot/>`_.
        
        Quick start
        -----------
        
        ::
        
            git clone https://gerrit.wikimedia.org/r/pywikibot/core.git
            cd core
            git submodule update --init
            python pwb.py script_name
        
        Or to install using PyPI (excluding scripts)
        ::
        
            pip install pywikibot --pre
        
        Our `installation
        guide <https://www.mediawiki.org/wiki/Special:MyLanguage/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:
        
        ::
        
            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
        
        -------------------------------------------------------------------------------------------
        
        For more documentation on pywikibot see our `docs <https://doc.wikimedia.org/pywikibot/>`_.
        
        
        The contents of the package
        ----------------------------
        
            +----------------------------------------------------------------------------------+
            |    README and config files:                                                      |
            +===========================+======================================================+
            |    ChangeLog              | Log file to keep track of major changes versionwise  |
            +---------------------------+------------------------------------------------------+
            |    CREDITS                | List of major contributors to this module            |
            +---------------------------+------------------------------------------------------+
            |    ez_setup.py            | Bootstrap distribute installation file, can also be  |
            |                           | run to install or upgrade setuptools.                |
            +---------------------------+------------------------------------------------------+
            |    generate_family_file.py| Creates a new family file.                           |
            +---------------------------+------------------------------------------------------+
            |    generate_user_files.py | Creates user-config.py or user-fixes.py              |
            +---------------------------+------------------------------------------------------+
            |    LICENSE                | a reference to the MIT license                       |
            +---------------------------+------------------------------------------------------+
            |    pwb.py                 | Wrapper script to use Pywikibot in 'directory' mode  |
            +---------------------------+------------------------------------------------------+
            |    README-conversion.txt  | Guide to converting bot scripts from version 1       |
            |                           | of the Pywikibot framework to version 2              |
            +---------------------------+------------------------------------------------------+
            |    README.rst             | Short info string used by Pywikibot Nightlies        |
            +---------------------------+------------------------------------------------------+
            |    requirements.txt       | PIP requirements file                                |
            +---------------------------+------------------------------------------------------+
            |    setup.py               | Installer script for Pywikibot 2.0 framework         |
            +---------------------------+------------------------------------------------------+
            |    user-config.py.sample  | Example user-config.py file for reference            |
            +---------------------------+------------------------------------------------------+
        
            +----------------------------------------------------------------------------------+
            |    Directories                                                                   |
            +===========================+======================================================+
            |    pywikibot              | Contains some libraries and control files            |
            +---------------------------+------------------------------------------------------+
            |    scripts                | Contains all bots and utility scripts                |
            +---------------------------+------------------------------------------------------+
            |    tests                  | Some test stuff for the developing team              |
            +---------------------------+------------------------------------------------------+
        
        
        Required external programs
        ---------------------------
        
        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
        
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
