jenkins-bot has submitted this change and it was merged. ( https://gerrit.wikimedia.org/r/381824 ) Change subject: [bugfix, doc] enable restructuredText inclusions ...................................................................... [bugfix, doc] enable restructuredText inclusions This patch is necessary for next pypi upload - setup.py cannot include files inside restructuredText files. Provide a procedure to enable it. - Update pypi classifiers - Update HISTORY.rst - Update CONTENT.rst and pywikibot/CONTENT.rst - fix some sections in rst-files Change-Id: Ifc26e40222b0f0c9a86d0b4974954245a12415e0 --- M CONTENT.rst M HISTORY.rst M README.rst M pywikibot/CONTENT.rst M pywikibot/DIRECTORIES.rst M setup.py 6 files changed, 74 insertions(+), 34 deletions(-) Approvals: Dalba: Looks good to me, approved jenkins-bot: Verified diff --git a/CONTENT.rst b/CONTENT.rst index b9b81af..769e7fa 100644 --- a/CONTENT.rst +++ b/CONTENT.rst @@ -1,46 +1,58 @@ The contents of the package ----------------------------- +--------------------------- +----------------------------------------------------------------------------------+ - | README and config files: | + | README and config files: | +===========================+======================================================+ - | ChangeLog | Log file to keep track of major changes versionwise | + | ChangeLog | Log file to keep track of major changes versionwise | +---------------------------+------------------------------------------------------+ - | CODE_OF_CONDUCT.md | Code of conduct reference | + | CODE_OF_CONDUCT.md | Code of conduct reference | +---------------------------+------------------------------------------------------+ - | CONTENT.rst | Content description file | + | CONTENT.rst | This Content description file | +---------------------------+------------------------------------------------------+ - | CREDITS | List of major contributors to this module | + | CREDITS | List of major contributors to this module | +---------------------------+------------------------------------------------------+ - | ez_setup.py | Bootstrap distribute installation file, can also be | + | dev-requirements.txt | PIP requirements file for development dependencies | + +---------------------------+------------------------------------------------------+ + | Dockerfile | assemble an image, install all dependencies via pip | + +---------------------------+------------------------------------------------------+ + | 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_family_file.py | Creates a new family file. | +---------------------------+------------------------------------------------------+ - | generate_user_files.py | Creates user-config.py or user-fixes.py | + | generate_user_files.py | Creates user-config.py or user-fixes.py | +---------------------------+------------------------------------------------------+ - | LICENSE | a reference to the MIT license | + | HISTORY.rst | pypi version history file | +---------------------------+------------------------------------------------------+ - | pwb.py | Wrapper script to use Pywikibot in 'directory' mode | + | LICENSE | a reference to the MIT license | +---------------------------+------------------------------------------------------+ - | README-conversion.txt | Guide to converting bot scripts from version 1 | + | pwb.py | Wrapper script to use Pywikibot in 'directory' mode | + +---------------------------+------------------------------------------------------+ + | README.rst | Short info string used by Pywikibot Nightlies | + +---------------------------+------------------------------------------------------+ + | README-conversion.txt | Guide to converting bot scripts from version 1 | | | of the Pywikibot framework to version 3 | +---------------------------+------------------------------------------------------+ - | README.rst | Short info string used by Pywikibot Nightlies | + | requests-requirements.txt | PIP requirements file for Appveyor builds | +---------------------------+------------------------------------------------------+ - | requirements.txt | PIP requirements file | + | requirements.txt | General PIP requirements file | +---------------------------+------------------------------------------------------+ - | setup.py | Installer script for Pywikibot 3.0 framework | + | setup.py | Installer script for Pywikibot 3.0 framework | +---------------------------+------------------------------------------------------+ - | user-config.py.sample | Example user-config.py file for reference | + | tox.ini | Tests config file | + +---------------------------+------------------------------------------------------+ + | user-config.py.sample | Example user-config.py file for reference | + +---------------------------+------------------------------------------------------+ + | user-fixes.py.sample | Example user-fixes.py file for reference | +---------------------------+------------------------------------------------------+ +----------------------------------------------------------------------------------+ - | Directories | + | Directories | +===========================+======================================================+ - | pywikibot | Contains some libraries and control files | + | pywikibot | Contains some libraries and control files | +---------------------------+------------------------------------------------------+ - | scripts | Contains all bots and utility scripts | + | scripts | Contains all bots and utility scripts | +---------------------------+------------------------------------------------------+ - | tests | Some test stuff for the developing team | + | tests | Some test stuff for the developing team | +---------------------------+------------------------------------------------------+ diff --git a/HISTORY.rst b/HISTORY.rst index 989c1bf..67027d1 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -1,9 +1,11 @@ Release history =============== -3.0.20170917 --------------- +Current release +--------------- +* 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/ diff --git a/README.rst b/README.rst index 927d103..da016a3 100644 --- a/README.rst +++ b/README.rst @@ -1,3 +1,4 @@ + Pywikibot ========= diff --git a/pywikibot/CONTENT.rst b/pywikibot/CONTENT.rst index ed47779..180c4e4 100644 --- a/pywikibot/CONTENT.rst +++ b/pywikibot/CONTENT.rst @@ -33,8 +33,6 @@ +---------------------------+-------------------------------------------------------+ | editor.py | Text editor class for your favourite editor | +---------------------------+-------------------------------------------------------+ - | epydoc.cfg | The list of objects to document | - +---------------------------+-------------------------------------------------------+ | exceptions.py | Exception classes used throughout the framework | +---------------------------+-------------------------------------------------------+ | family.py | Abstract superclass for wiki families. Subclassed by | @@ -172,6 +170,8 @@ +----------------------------+------------------------------------------------------+ | CONTENT.rst | This file ( Short info on all modules ) | +----------------------------+------------------------------------------------------+ + | epydoc.cfg | The list of objects to document | + +----------------------------+------------------------------------------------------+ | READMY.rst | Package description file | +----------------------------+------------------------------------------------------+ diff --git a/pywikibot/DIRECTORIES.rst b/pywikibot/DIRECTORIES.rst index 1ad16eb..0e5a733 100644 --- a/pywikibot/DIRECTORIES.rst +++ b/pywikibot/DIRECTORIES.rst @@ -1,5 +1,5 @@ The contents of the package ----------------------------- +--------------------------- +----------------------------------------------------------------------------------+ | Directories | diff --git a/setup.py b/setup.py index 6e895d5..00972fc 100644 --- a/setup.py +++ b/setup.py @@ -214,17 +214,36 @@ print(e) version = version + "-dev" -github_url = 'https://github.com/wikimedia/pywikibot-core' -with open('README.rst') as f: - long_description = f.read() + +def read_desc(filename): + """Read long description. + + Combine included restructured text files which must be done before + uploading because the source isn't available after creating the package. + """ + desc = [] + with open(filename) as f: + for line in f: + if line.strip().startswith('.. include::'): + include = os.path.relpath(line.rsplit('::')[1].strip()) + if os.path.exists(include): + with open(include) as g: + desc.append(g.read()) + else: + print('Cannot include {0}; file not found'.format(include)) + else: + desc.append(line) + return ''.join(desc) + setup( name=name, version=version, description='Python MediaWiki Bot Framework', - long_description=long_description, - keywords=('pywikibot', 'python', 'mediawiki', 'bot', 'wiki', 'framework', - 'wikimedia', 'wikipedia', 'pwb', 'pywikipedia', 'API'), + long_description=read_desc('README.rst'), + keywords=('API', 'bot', 'framework', 'mediawiki', 'pwb', 'python', + 'pywikibot', 'pywikipedia', 'pywikipediabot', 'wiki', + 'wikimedia', 'wikipedia'), maintainer='The Pywikibot team', maintainer_email=&#39;pywikibot(a)lists.wikimedia.org&#39;org', license='MIT License', @@ -235,19 +254,25 @@ dependency_links=dependency_links, extras_require=extra_deps, url='https://www.mediawiki.org/wiki/Pywikibot'bot', + download_url='https://tools.wmflabs.org/pywikibot/'ot/', test_suite="tests.collector", tests_require=test_deps, classifiers=[ - 'License :: OSI Approved :: MIT License', 'Development Status :: 4 - Beta', - 'Operating System :: OS Independent', - 'Intended Audience :: Developers', 'Environment :: Console', + 'Intended Audience :: Developers', + 'License :: OSI Approved :: MIT License', + 'Natural Language :: English', + 'Operating System :: OS Independent', + 'Programming Language :: Python :: 2.6', 'Programming Language :: Python :: 2.7', 'Programming Language :: Python :: 3.3', 'Programming Language :: Python :: 3.4', 'Programming Language :: Python :: 3.5', 'Programming Language :: Python :: 3.6', + 'Topic :: Internet :: WWW/HTTP :: Dynamic Content :: Wiki', + 'Topic :: Software Development :: Libraries :: Python Modules', + 'Topic :: Utilities', ], use_2to3=False ) -- To view, visit https://gerrit.wikimedia.org/r/381824 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: Ifc26e40222b0f0c9a86d0b4974954245a12415e0 Gerrit-PatchSet: 6 Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-Owner: Xqt &lt;info(a)gno.de&gt; Gerrit-Reviewer: Dalba &lt;dalba.wiki(a)gmail.com&gt; Gerrit-Reviewer: John Vandenberg &lt;jayvdb(a)gmail.com&gt; Gerrit-Reviewer: Magul &lt;tomasz.magulski(a)gmail.com&gt; Gerrit-Reviewer: Merlijn van Deen &lt;valhallasw(a)arctus.nl&gt; Gerrit-Reviewer: Xqt &lt;info(a)gno.de&gt; Gerrit-Reviewer: Zoranzoki21 &lt;zorandori4444(a)gmail.com&gt; Gerrit-Reviewer: jenkins-bot <>