jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/676438 )

Change subject: [doc] Additional doc from mediawiki ......................................................................

[doc] Additional doc from mediawiki

See https://www.mediawiki.org/wiki/Manual:Pywikibot/Overview

Also - fix flake8 bugbear dependency - use strftime('%Y') for current copyright year

Change-Id: Ifb92d192a85f7a5485568e237c143dd13407d6a8 --- M docs/conf.py M docs/index.rst M pywikibot/__metadata__.py M setup.py 4 files changed, 26 insertions(+), 8 deletions(-)

Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified

diff --git a/docs/conf.py b/docs/conf.py index c9a39d9..265636b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -79,7 +79,7 @@ # built documents. # # The short X.Y version. -version = pywikibot.__version__ +version = pywikibot.__version__.partition('.dev')[0] # The full version, including alpha/beta/rc tags. release = pywikibot.__version__

diff --git a/docs/index.rst b/docs/index.rst index 3607626..22ceaa0 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,5 +1,7 @@ -Welcome to Pywikibot! -===================== +Pywikibot 6.1.0 Documentation +============================= + +Welcome! This is the documentation for Pywikibot 6.1.0.

.. note::

@@ -10,12 +12,27 @@

`Manual:Pywikibot on mediawiki.org https://www.mediawiki.org/wiki/Manual:Pywikibot`_

+**Pywikibot** is a Python library and collection of tools that automate work +on `MediaWiki https://mediawiki.org`_ sites. Originally designed for +Wikipedia, it is now used throughout the Wikimedia Foundation's projects and +on many other MediaWiki wikis.

-Pywikibot is a Python library and collection of scripts that automate work on `MediaWiki https://mediawiki.org`_ sites. +The project started in 2003 and is currently on core version 6.1.0. +It features full API usage and is up-to-date with new MediaWiki features and +a Pythonic package layout. But it also works with older installations of +MediaWiki 1.23 or higher.

-Pywikibot supports Python 3.5+. +Pywikibot supports Microsoft Windows, macOS and Linux when used with a +compatible version of Python. It should also work on any other operating +system that has a compatible version of Python installed. To check +whether you have Python installed and to find its version, just type +``python`` at the CMD or shell prompt.

-Pywikibot and this documentation are licensed under the :ref:`MIT license <licenses-MIT>`; +Python 3.5 or higher is currently required to run the bot, but Python 3.6 +or higher is recommended. + +Pywikibot and this documentation are licensed under the +:ref:`MIT license <licenses-MIT>`; manual pages on mediawiki.org are licensed under the `CC-BY-SA 3.0`_ license.

The documentation consists of four major parts: diff --git a/pywikibot/__metadata__.py b/pywikibot/__metadata__.py index 9c335de..45e3e59 100644 --- a/pywikibot/__metadata__.py +++ b/pywikibot/__metadata__.py @@ -4,6 +4,7 @@ # # Distributed under the terms of the MIT license. # +from time import strftime __name__ = 'pywikibot' __version__ = '6.1.0.dev0' __description__ = 'Python MediaWiki Bot Framework' @@ -12,7 +13,7 @@ __license__ = 'MIT License' __url__ = 'https://www.mediawiki.org/wiki/Manual:Pywikibot' __download_url__ = 'https://pywikibot.toolforge.org/' -__copyright__ = '(C) Pywikibot team, 2003-2021' +__copyright__ = '(C) Pywikibot team, 2003-' + strftime('%Y') __keywords__ = 'API bot client framework mediawiki pwb pybot python pywiki ' \ 'pywikibase pywikibot pywikipedia pywikipediabot wiki ' \ 'wikibase wikidata wikimedia wikipedia' diff --git a/setup.py b/setup.py index 6e60450..58d111e 100644 --- a/setup.py +++ b/setup.py @@ -72,7 +72,7 @@ 'flake8>=3.7.5', 'pydocstyle>=4.0.0', 'hacking', - 'flake8-bugbear', + 'flake8-bugbear!=21.4.1', 'flake8-coding', 'flake8-colors>=0.1.9', 'flake8-comprehensions>=3.1.4;python_version>="3.8"',