Metadata-Version: 1.2
Name: pywikibot
Version: 3.0.20190106
Summary: Python MediaWiki Bot Framework
Home-page: https://www.mediawiki.org/wiki/Manual:Pywikibot
Author: The Pywikibot team
Author-email: pywikibot@lists.wikimedia.org
License: MIT License
Download-URL: https://tools.wmflabs.org/pywikibot/
Description: .. image:: https://travis-ci.org/wikimedia/pywikibot.svg?branch=master
           :alt: Travis Build Status
           :target: https://travis-ci.org/wikimedia/pywikibot
        .. image:: https://img.shields.io/appveyor/ci/ladsgroup/pywikibot-g4xqx/master.svg?style=flat-square&label=AppVeyor%20CI
           :alt: AppVeyor Build Status
           :target: https://ci.appveyor.com/project/ladsgroup/pywikibot-g4xqx
        .. image:: https://codecov.io/gh/wikimedia/pywikibot/branch/master/graph/badge.svg
           :alt: Code coverage
           :target: https://codecov.io/gh/wikimedia/pywikibot
        .. image:: https://api.codeclimate.com/v1/badges/de6ca4c66e7c7bee4156/maintainability
           :alt: Maintainability
           :target: https://codeclimate.com/github/wikimedia/pywikibot/maintainability
        .. image:: https://img.shields.io/pypi/pyversions/pywikibot.svg
           :alt: Python
           :target: https://www.python.org/downloads/
        .. image:: https://img.shields.io/pypi/v/pywikibot.svg
           :alt: Pywikibot release
           :target: https://pypi.org/project/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.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 -U setuptools
            pip install pywikibot
        
        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:
        
        ::
        
            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
        ---------------
        
        * Ensure "modules" parameter of ParamInfo._fetch is a set (T122763)
        * Support adding new claims with qualifiers and/or references (T112577, T170432)
        * Support LZMA and XZ compression formats
        * Update correct-ar Typo corrections in fixes.py (T211492)
        * Enable MediaWiki timestamp with EventStreams (T212133)
        * Convert Timestamp.fromtimestampformat() if year, month and day are given only
        * tools.concat_options is deprecated
        * Additional ListOption subclasses ShowingListOption, MultipleChoiceList, ShowingMultipleChoiceList
        * Bugfixes and improvements
        * Localisation updates
        
        3.0.20181203
        ------------
        
        * Remove compat module references from autogenerated docs (T183085)
        * site.preloadpages: split pagelist in most max_ids elements (T209111)
        * Disable empty sections in cosmetic_changes for user namespace
        * Prevent touch from re-creating pages (T193833)
        * New Page.title() parameter without_brackets; also used by titletranslate (T200399)
        * Security: require requests version 2.20.0 or later (T208296)
        * Check appropriate key in Site.messages (T163661)
        * Make sure the cookie file is created with the right permissions (T206387)
        * pydot >= 1.2 is required for interwiki_graph
        * Move methods for simple claim adding/removing to WikibasePage (T113131)
        * Enable start timestamp for EventStreams (T205121)
        * Re-enable notifications (T205184)
        * Use FutureWarning for warnings intended for end users (T191192)
        * Provide new -wanted... page generators (T56557, T150222)
        * api.QueryGenerator: Handle slots during initialization (T200955, T205210)
        * Bugfixes and improvements
        * Localisation updates
        
        3.0.20180922
        ------------
        
        * Enable multiple streams for EventStreams (T205114)
        * Fix Wikibase aliases handling (T194512)
        * Remove cryptography support from python<=2.7.6 requirements (T203435)
        * textlib._tag_pattern: Do not mistake self-closing tags with start tag (T203568)
        * page.Link.langlinkUnsafe: Always set _namespace to a Namespace object (T203491)
        * Enable Namespace.content for mw < 1.16
        * Allow terminating the bot generator by BaseBot.stop() method (T198801)
        * Allow bot parameter in set_redirect_target
        * Do not show empty error messages (T203462)
        * Show the exception message in async mode (T203448)
        * Fix the extended user-config extraction regex (T145371)
        * Solve UnicodeDecodeError in site.getredirtarget (T126192)
        * Introduce a new APISite property: mw_version
        * Improve hash method for BasePage and Link
        * Avoid applying two uniquifying filters (T199615)
        * Fix skipping of language links in CosmeticChangesToolkit.removeEmptySections (T202629)
        * New mediawiki projects were provided
        * Bugfixes and improvements
        * Localisation updates
        
        3.0.20180823
        ------------
        
        * Don't reset Bot._site to None if we have already a site object (T125046)
        * pywikibot.site.Siteinfo: Fix the bug in cache_time when loading a CachedRequest (T202227)
        * pagegenerators._handle_recentchanges: Do not request for reversed results (T199199)
        * Use a key for filter_unique where appropriate (T199615)
        * pywikibot.tools: Add exceptions for first_upper (T200357)
        * Fix usages of site.namespaces.NAMESPACE_NAME (T201969)
        * pywikibot/textlib.py: Fix header regex to allow comments
        * Use 'rvslots' when fetching revisions on MW 1.32+ (T200955)
        * Drop the '2' from PYWIKIBOT2_DIR, PYWIKIBOT2_DIR_PWB, and PYWIKIBOT2_NO_USER_CONFIG environment variables. The old names are now deprecated. The other PYWIKIBOT2_* variables which were used only for testing purposes have been renamed without deprecation. (T184674)
        * Introduce a timestamp in deprecated decorator (T106121)
        * textlib.extract_sections: Remove footer from the last section (T199751)
        * Don't let WikidataBot crash on save related errors (T199642)
        * Allow different projects to have different L10N entries (T198889)
        * remove color highlights before fill function (T196874)
        * Fix Portuguese file namespace translation in cc (T57242)
        * textlib._create_default_regexes: Avoid using inline flags (T195538)
        * Not everything after a language link is footer (T199539)
        * code cleanups
        * New mediawiki projects were provided
        * Bugfixes and improvements
        * Localisation updates
        
        3.0.20180710
        ------------
        
        * Enable any LogEntry subclass for each logevent type (T199013)
        * Deprecated pagegenerators options -<logtype>log aren't supported any longer (T199013)
        * Open RotatingFileHandler with utf-8 encoding (T188231)
        * Fix occasional failure of TestLogentries due to hidden namespace (T197506)
        * Remove multiple empty sections at once in cosmetic_changes (T196324)
        * Fix stub template position by putting it above interwiki comment (T57034)
        * Fix handling of API continuation in PropertyGenerator (T196876)
        * Use PyMySql as pure-Python MySQL client library instead of oursql, deprecate MySQLdb (T89976, T142021)
        * Ensure that BaseBot.treat is always processing a Page object (T196562, T196813)
        * Update global bot settings
        * New mediawiki projects were provided
        * Bugfixes and improvements
        * Localisation updates
        
        3.0.20180603
        ------------
        
        * Move main categories to top in cosmetic_changes
        * shell.py always imports pywikibot as default
        * New roundrobin_generators in tools
        * New BaseBot method "skip_page" to adjust page counting
        * Family class is made a singleton class
        * New rule 'startcolon' was introduced in textlib
        * BaseBot has new methods setup and teardown
        * UploadBot got a filename prefix parameter (T170123)
        * cosmetic_changes is able to remove empty sections (T140570)
        * Pywikibot is following PEP 396 versioning
        * pagegenerators AllpagesPageGenerator, CombinedPageGenerator, UnconnectedPageGenerator are deprecated
        * Some DayPageGenerator parameters has been renamed
        * unicodedata2, httpbin and Flask dependency was removed (T102461, T108068, T178864, T193383)
        * New projects were provided
        * Bugfixes and improvements
        * Documentation updates
        * Localisation updates (T194893)
        * Translation updates
        
        3.0.20180505
        ------------
        
        * Enable makepath and datafilepath not to create the directory
        * Use API's retry-after value (T144023)
        * Provide startprefix parameter for Category.articles() (T74101, T143120)
        * Page.put_async() is marked as deprecated (T193494)
        * pagegenerators.RepeatingGenerator is marked as deprecated (T192229)
        * Deprecate requests-requirements.txt (T193476)
        * Bugfixes and improvements
        * New mediawiki projects were provided
        * Localisation updates
        
        3.0.20180403
        ------------
        
        * Deprecation warning: support for Python 2.7.2 and 2.7.3 will be dropped (T191192)
        * Dropped support for Python 2.6 (T154771)
        * Dropped support for Python 3.3 (T184508)
        * Bugfixes and improvements
        * Localisation updates
        
        3.0.20180304
        ------------
        
        * 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 were added
        * new family files were supported
        * some scripts were 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/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
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content :: Wiki
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Requires-Python: >=2.7.2, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*
