Metadata-Version: 1.1
Name: pywikibot
Version: 3.0.20180304
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
Download-URL: https://tools.wmflabs.org/pywikibot/
Description: .. image:: https://secure.travis-ci.org/wikimedia/pywikibot.png?branch=master
           :alt: Build Status
           :target: https://travis-ci.org/wikimedia/pywikibot
        .. image:: https://codecov.io/gh/wikimedia/pywikibot/branch/master/graphs/badge.svg?branch=master
           :alt: Code coverage
           :target: http://codecov.io/github/wikimedia/pywikibot?branch=master
        .. image:: https://codeclimate.com/github/wikimedia/pywikibot-core/badges/gpa.svg
           :alt: Maintainability
           :target: https://codeclimate.com/github/wikimedia/pywikibot-core
        .. image:: https://img.shields.io/pypi/v/pywikibot.svg
           :alt: Pywikibot release
           :target: https://pypi.python.org/pypi/pywikibot
        
        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
        ---------------------------
        
            +----------------------------------------------------------------------------------+
            |  Directories                                                                     |
            +===========================+======================================================+
            |  pywikibot                | Library routines, control files and global settings  |
            +---------------------------+------------------------------------------------------+
            |  pywikibot/comms          | Communication layer                                  |
            +---------------------------+------------------------------------------------------+
            |  pywikibot/compat         | Package to provide compatibility with compat scripts |
            +---------------------------+------------------------------------------------------+
            |  pywikibot/data           | Module with several layers for data access to wiki   |
            +---------------------------+------------------------------------------------------+
            |  pywikibot/families       | wiki-specific information and settings               |
            +---------------------------+------------------------------------------------------+
            |  pywikibot/tools          | Miscellaneous helper functions (not wiki-dependent)  |
            +---------------------------+------------------------------------------------------+
            |  pywikibot/userinterfaces | GUI and terminal interface                           |
            +---------------------------+------------------------------------------------------+
        
        Required external programs
        ---------------------------
        
        It may require the following programs to function properly:
        
        * `7za`: To extract 7z files
        
        Release history
        ===============
        
        Current release
        ---------------
        
        * Bugfixes and improvements
        * Localisation updates
        
        3.0.20180302
        ------------
        
        * Changed requirements for requests and sseclient
        * Bugfixes and improvements
        * Localisation updates
        
        3.0.20180204
        ------------
        
        * Deprecation warning: support for py2.6 and py3.3 will be dropped
        * Changed requirements for cryprography, Pillow and pyOpenSSL
        * Bugfixes and improvements
        * Localisation updates
        
        3.0.20180108
        ------------
        
        * Maintenance script to download Wikimedia database dump
        * Option to auto-create accounts when logging in
        * Ship wikimania family file
        * Drop battlestarwiki family file
        * Bugfixes and improvements
        * Localisation updates
        
        3.0.20171212
        ------------
        
        * Introduce userscripts directory
        * Generator settings inside (user-)fixes.py
        * BaseUnlinkBot has become part of the framework in specialbots.py
        * Decommission of rcstream
        * Script files added to https://doc.wikimedia.org/pywikibot/
        * Other documentation updates
        * Bugfixes and improvements
        * Localisation updates
        
        3.0.20170801
        ------------
        
        * Bugfixes and improvements
        * Localisation updates
        
        3.0.20170713
        ------------
        
        * Implement server side event client EventStreams
        * Add thanks log support
        * new ndashredir.py script to create hyphenated redirects
        * new followlive.py script to flag new articles
        * new WbUnknown data type for Wikibase
        * Deprecate APISite.newfiles()
        * new pagegenerators filter option -titleregexnot
        * Inverse of pagegenerators -namespace option
        * Bugfixes and improvements
        * Localisation updates
        * Remove panoramiopicker.py script
        * Remove anarchopedia family out of the framework
        * CODE_OF_CONDUCT included
        
        3.0.20170521
        ------------
        
        * Replaced the word 'async' with 'asynchronous' due to python 3.7
        * Support for Python 2.6 but higher releases are strictly recommended
        * Bugfixes and improvements
        * Localisation updates
        
        3.0.20170403
        ------------
        
        * First major release from master branch
        * requests package is mandatory
        * Deprecate previous 2.0 branches
        
        2.0rc5
        ------
        
        * Last stable 2.0 branch
        
        2.0rc4
        ------
        
        * Remove dependency on pYsearch
        * Desupport Python 2.6 for Pywikibot 2.0 release branch
        
        2.0rc3
        ------
        
        * Bugfixes
        * Localisation updates
        * i18n: always follow master branch
        
        2.0rc2
        ------
        
        * Bugfixes and improvements
        * Localisation updates
        
        
        2.0rc1
        ------
        
        * New scripts patrol.py and piper.py ported from old compat branch
        * isbn.py now supports wikibase
        * RecentChanges stream (rcstream) support
        * Sphinx documentation at https://doc.wikimedia.org/pywikibot/
        * Bugfixes and improvements
        * Localisation updates
        
        2.0b3
        -----
        
        * Bugfixes and improvements
        
        2.0b2
        -----
        
        * Bugfixes and improvements
        
        2.0b1
        -----
        
        * First stable release branch
        
        1.0 rv 2007-06-19
        -----------------
        * BeautifulSoup becomes mandatory
        * new scripts where added
        * new family files where supported
        * some scripts where archived
        
        1.0
        ---
        
        *Sep 26, 2005*
        
        * First PyWikipediaBot framework release
        * scripts and libraries for standardizing content
        * tools for making minor modifications
        * script making interwiki links
        
        
        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.
        
        Code of Conduct
        ---------------
        
        The development of this software is covered by a `Code of Conduct <https://www.mediawiki.org/wiki/Code_of_Conduct>`_.
        
        
Keywords: API,bot,framework,mediawiki,pwb,python,pywikibot,pywikipedia,pywikipediabot,wiki,wikimedia,wikipedia
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content :: Wiki
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
