jenkins-bot has submitted this change and it was merged. (
https://gerrit.wikimedia.org/r/375541 )
Change subject: [bugfix] Re-enable installation from pypi package
......................................................................
[bugfix] Re-enable installation from pypi package
- rename pypi descripton file which must be the same name as in subfolder
- Also add release history to pypi description
Bug: T176085
Change-Id: Ibca3cc0f545d6481f6c3427b5d14a4e7f7aadf86
---
A CONTENT.rst
A HISTORY.rst
M README.rst
D pypi_description.rst
A pywikibot/CONTENT.rst
A pywikibot/DIRECTORIES.rst
M pywikibot/README.rst
M setup.py
8 files changed, 357 insertions(+), 311 deletions(-)
Approvals:
Merlijn van Deen: Looks good to me, approved
jenkins-bot: Verified
diff --git a/CONTENT.rst b/CONTENT.rst
new file mode 100644
index 0000000..b9b81af
--- /dev/null
+++ b/CONTENT.rst
@@ -0,0 +1,46 @@
+The contents of the package
+----------------------------
+
+ +----------------------------------------------------------------------------------+
+ | README and config files: |
+ +===========================+======================================================+
+ | ChangeLog | Log file to keep track of major changes versionwise |
+ +---------------------------+------------------------------------------------------+
+ | CODE_OF_CONDUCT.md | Code of conduct reference |
+ +---------------------------+------------------------------------------------------+
+ | CONTENT.rst | Content description file |
+ +---------------------------+------------------------------------------------------+
+ | 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 3 |
+ +---------------------------+------------------------------------------------------+
+ | README.rst | Short info string used by Pywikibot Nightlies |
+ +---------------------------+------------------------------------------------------+
+ | requirements.txt | PIP requirements file |
+ +---------------------------+------------------------------------------------------+
+ | setup.py | Installer script for Pywikibot 3.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 |
+ +---------------------------+------------------------------------------------------+
diff --git a/HISTORY.rst b/HISTORY.rst
new file mode 100644
index 0000000..989c1bf
--- /dev/null
+++ b/HISTORY.rst
@@ -0,0 +1,101 @@
+Release history
+===============
+
+3.0.20170917
+--------------
+
+* 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
+
diff --git a/README.rst b/README.rst
index 7858840..927d103 100644
--- a/README.rst
+++ b/README.rst
@@ -47,50 +47,7 @@
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 3 |
- +---------------------------+------------------------------------------------------+
- | README.rst | Short info string used by Pywikibot Nightlies |
- +---------------------------+------------------------------------------------------+
- | requirements.txt | PIP requirements file |
- +---------------------------+------------------------------------------------------+
- | setup.py | Installer script for Pywikibot 3.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 |
- +---------------------------+------------------------------------------------------+
-
+.. include:: pywikibot/DIRECTORIES.rst
Required external programs
---------------------------
@@ -99,13 +56,18 @@
* `7za`: To extract 7z files
+.. include:: HISTORY.rst
+
Contributing
------------
-Our code is maintained on Wikimedia's
-`Gerrit installation
<https://gerrit.wikimedia.org/r/#/admin/projects/?filter=pywikibot>`_.
-Learn about `how to contribute
<https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Pywikibot/Development>`_.
+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
+.. image::
https://img.shields.io/pypi/v/pywikibot.svg
+ :alt: Pywikibot release
+ :target:
https://pypi.python.org/pypi/pywikibot
\ No newline at end of file
diff --git a/pypi_description.rst b/pypi_description.rst
deleted file mode 100644
index 25af392..0000000
--- a/pypi_description.rst
+++ /dev/null
@@ -1,89 +0,0 @@
-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
-
-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
diff --git a/pywikibot/CONTENT.rst b/pywikibot/CONTENT.rst
new file mode 100644
index 0000000..ed47779
--- /dev/null
+++ b/pywikibot/CONTENT.rst
@@ -0,0 +1,177 @@
+The contents of the package
+---------------------------
+
+
+-----------------------------------------------------------------------------------+
+ | Library routines
|
+
+===========================+=======================================================+
+ | __init__.py | Initialization of the pywikibot framework,
|
+ | | basic classes and methods
|
+
+---------------------------+-------------------------------------------------------+
+ | _wbtypes.py | Wikibase data type classes
|
+
+---------------------------+-------------------------------------------------------+
+ | backports.py | Module contains backports to support older Python
|
+ | | versions
|
+
+---------------------------+-------------------------------------------------------+
+ | bot.py | User-interface related functions for building bots
|
+
+---------------------------+-------------------------------------------------------+
+ | bot_choice.py | Classes for input_choice
|
+
+---------------------------+-------------------------------------------------------+
+ | botirc.py | User-interface related functions for building irc bot
|
+
+---------------------------+-------------------------------------------------------+
+ | config2.py | Module to define and load pywikibot configuration
|
+
+---------------------------+-------------------------------------------------------+
+ | cosmetic_changes.py | Slight modifications to a wiki page's source code
|
+
+---------------------------+-------------------------------------------------------+
+ | daemonize.py | Daemonize the current process on Unix
|
+
+---------------------------+-------------------------------------------------------+
+ | date.py | Date formats in various languages
|
+
+---------------------------+-------------------------------------------------------+
+ | diff.py | Diff module
|
+
+---------------------------+-------------------------------------------------------+
+ | echo.py | Classes and functions for working with the Echo
|
+ | | extension
|
+
+---------------------------+-------------------------------------------------------+
+ | 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
|
+ | | the classes in the 'families' subdirectory.
|
+
+---------------------------+-------------------------------------------------------+
+ | fixes.py | File containing all standard fixes, stores predefined
|
+ | | replacements used by replace.py.
|
+
+---------------------------+-------------------------------------------------------+
+ | flow.py | Objects representing Flow entities
|
+
+---------------------------+-------------------------------------------------------+
+ | i18n.py | Helper functions for both the internal translation
|
+ | | system and for TranslateWiki-based translations
|
+
+---------------------------+-------------------------------------------------------+
+ | interwiki_graph.py | Possible create graph with interwiki.py.
|
+
+---------------------------+-------------------------------------------------------+
+ | logentries.py | Objects representing Mediawiki log entries
|
+
+---------------------------+-------------------------------------------------------+
+ | logging.py | Logging and output functions
|
+
+---------------------------+-------------------------------------------------------+
+ | login.py | Log in to an account on your "home" wiki. or
check |
+ | | login status
|
+
+---------------------------+-------------------------------------------------------+
+ | page.py | Allows access to the site's bot user list.
|
+
+---------------------------+-------------------------------------------------------+
+ | pagegenerators.py | Generator pages.
|
+
+---------------------------+-------------------------------------------------------+
+ | plural.py | Module containing plural rules of various languages
|
+
+---------------------------+-------------------------------------------------------+
+ | proofreadpage.py | Objects representing objects used with ProofreadPage
|
+ | | Extension
|
+
+---------------------------+-------------------------------------------------------+
+ | site.py | Objects representing MediaWiki sites (wikis)
|
+
+---------------------------+-------------------------------------------------------+
+ | site_detect.py | Classes for detecting a MediaWiki site
|
+
+---------------------------+-------------------------------------------------------+
+ | specialbots.py | Predefined special bot classes
|
+
+---------------------------+-------------------------------------------------------+
+ | textlib.py | Functions for manipulating wiki-text
|
+
+---------------------------+-------------------------------------------------------+
+ | throttle.py | Mechanics to slow down wiki read and/or write rate
|
+
+---------------------------+-------------------------------------------------------+
+ | titletranslate.py | Rules and tricks to auto-translate wikipage titles
|
+ | | articles.
|
+
+---------------------------+-------------------------------------------------------+
+ | version.py | Module to determine the pywikibot version (tag,
|
+ | | revision and date)
|
+
+---------------------------+-------------------------------------------------------+
+ | weblib.py | Functions for manipulating external links or querying
|
+ | | third-party sites
|
+
+---------------------------+-------------------------------------------------------+
+ | xmlreader.py | Reading and parsing XML dump files.
|
+
+---------------------------+-------------------------------------------------------+
+
+
+
+---------------------------+-------------------------------------------------------+
+ | comms | Communication layer.
|
+
+===========================+=======================================================+
+ | eventstreams.py | stream client for server sent events
|
+
+---------------------------+-------------------------------------------------------+
+ | http.py | Basic HTTP access interface
|
+
+---------------------------+-------------------------------------------------------+
+ | threadedhttp.py | Httplib2 threaded cookie layer extending httplib2
|
+
+---------------------------+-------------------------------------------------------+
+
+
+
+---------------------------+-------------------------------------------------------+
+ | compat | Package to provide compatibility with compat scripts.
|
+ | | (should never be used)
|
+
+===========================+=======================================================+
+ | catlib.py | Library routines written especially to handle
|
+ | | category pages and recurse over category contents.
|
+
+---------------------------+-------------------------------------------------------+
+ | query.py | API query library
|
+
+---------------------------+-------------------------------------------------------+
+ | userlib.py | Library to work with users, their pages and talk page
|
+
+---------------------------+-------------------------------------------------------+
+
+
+
+---------------------------+-------------------------------------------------------+
+ | data | Module providing several layers of data access to
wiki|
+
+===========================+=======================================================+
+ | api.py | Interface to Mediawiki's api.php
|
+
+---------------------------+-------------------------------------------------------+
+ | mysql.py | Miscellaneous helper functions for mysql queries
|
+
+---------------------------+-------------------------------------------------------+
+ | sparql.py | Objects representing SPARQL query API
|
+
+---------------------------+-------------------------------------------------------+
+ | wikistats.py | Objects representing WikiStats API
|
+
+---------------------------+-------------------------------------------------------+
+
+
+
+---------------+-------------------------------------------------------------------+
+ | tools | Miscellaneous helper functions (not wiki-dependent).
|
+
+===============+===================================================================+
+ | __init__.py | several classes and methods
|
+
+---------------+-------------------------------------------------------------------+
+ | _logging.py | Logging tools
|
+
+---------------+-------------------------------------------------------------------+
+ | chars.py | Character based helper functions(not wiki-dependent)
|
+
+---------------+-------------------------------------------------------------------+
+ | djvu.py | Wrapper around djvulibre to access djvu properties and content
|
+
+---------------+-------------------------------------------------------------------+
+ | formatter.py | Various formatting related utilities
|
+
+---------------+-------------------------------------------------------------------+
+ | ip.py | IP address tools module
|
+
+---------------+-------------------------------------------------------------------+
+
+
+
+-----------------------------------------------------------------------------------+
+ | User Interface
|
+
+============================+======================================================+
+ | cgi_interface.py | CGI user interface
|
+
+----------------------------+------------------------------------------------------+
+ | gui.py | GUI with a unicode textfield where the user can edit
|
+
+----------------------------+------------------------------------------------------+
+ | terminal_interface.py | Platform independent terminal interface module
|
+
+----------------------------+------------------------------------------------------+
+ | terminal_interface_base.py | Base for terminal user interfaces
|
+
+----------------------------+------------------------------------------------------+
+ | terminal_interface_unix.py | User interface for unix terminals
|
+
+----------------------------+------------------------------------------------------+
+ | terminal_interface_win32.py| User interface for Win32 terminals
|
+
+----------------------------+------------------------------------------------------+
+ | transliteration.py | Module to transliterate text
|
+
+----------------------------+------------------------------------------------------+
+ | win32_unicode.py | Stdout, stderr and argv support for unicode
|
+
+----------------------------+------------------------------------------------------+
+
+
+
+-----------------------------------------------------------------------------------+
+ | Others
|
+
+============================+======================================================+
+ | families (folder) | Contains wiki-specific information like URLs,
|
+ | | languages, encodings etc.
|
+
+----------------------------+------------------------------------------------------+
+ | CONTENT.rst | This file ( Short info on all modules )
|
+
+----------------------------+------------------------------------------------------+
+ | READMY.rst | Package description file
|
+
+----------------------------+------------------------------------------------------+
+
diff --git a/pywikibot/DIRECTORIES.rst b/pywikibot/DIRECTORIES.rst
new file mode 100644
index 0000000..1ad16eb
--- /dev/null
+++ b/pywikibot/DIRECTORIES.rst
@@ -0,0 +1,20 @@
+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 |
+ +---------------------------+------------------------------------------------------+
diff --git a/pywikibot/README.rst b/pywikibot/README.rst
index 181ddd3..5fa9326 100644
--- a/pywikibot/README.rst
+++ b/pywikibot/README.rst
@@ -12,180 +12,7 @@
`Manual:Pywikibot <http://www.mediawiki.org/wiki/Manual:Pywikibot>`_
-The contents of the package
----------------------------
-
-
+-----------------------------------------------------------------------------------+
- | Library routines
|
-
+===========================+=======================================================+
- | __init__.py | Initialization of the pywikibot framework,
|
- | | basic classes and methods
|
-
+---------------------------+-------------------------------------------------------+
- | _wbtypes.py | Wikibase data type classes
|
-
+---------------------------+-------------------------------------------------------+
- | backports.py | Module contains backports to support older Python
|
- | | versions
|
-
+---------------------------+-------------------------------------------------------+
- | bot.py | User-interface related functions for building bots
|
-
+---------------------------+-------------------------------------------------------+
- | bot_choice.py | Classes for input_choice
|
-
+---------------------------+-------------------------------------------------------+
- | botirc.py | User-interface related functions for building irc bot
|
-
+---------------------------+-------------------------------------------------------+
- | config2.py | Module to define and load pywikibot configuration
|
-
+---------------------------+-------------------------------------------------------+
- | cosmetic_changes.py | Slight modifications to a wiki page's source code
|
-
+---------------------------+-------------------------------------------------------+
- | daemonize.py | Daemonize the current process on Unix
|
-
+---------------------------+-------------------------------------------------------+
- | date.py | Date formats in various languages
|
-
+---------------------------+-------------------------------------------------------+
- | diff.py | Diff module
|
-
+---------------------------+-------------------------------------------------------+
- | echo.py | Classes and functions for working with the Echo
|
- | | extension
|
-
+---------------------------+-------------------------------------------------------+
- | 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
|
- | | the classes in the 'families' subdirectory.
|
-
+---------------------------+-------------------------------------------------------+
- | fixes.py | File containing all standard fixes, stores predefined
|
- | | replacements used by replace.py.
|
-
+---------------------------+-------------------------------------------------------+
- | flow.py | Objects representing Flow entities
|
-
+---------------------------+-------------------------------------------------------+
- | i18n.py | Helper functions for both the internal translation
|
- | | system and for TranslateWiki-based translations
|
-
+---------------------------+-------------------------------------------------------+
- | interwiki_graph.py | Possible create graph with interwiki.py.
|
-
+---------------------------+-------------------------------------------------------+
- | logentries.py | Objects representing Mediawiki log entries
|
-
+---------------------------+-------------------------------------------------------+
- | logging.py | Logging and output functions
|
-
+---------------------------+-------------------------------------------------------+
- | login.py | Log in to an account on your "home" wiki. or
check |
- | | login status
|
-
+---------------------------+-------------------------------------------------------+
- | page.py | Allows access to the site's bot user list.
|
-
+---------------------------+-------------------------------------------------------+
- | pagegenerators.py | Generator pages.
|
-
+---------------------------+-------------------------------------------------------+
- | plural.py | Module containing plural rules of various languages
|
-
+---------------------------+-------------------------------------------------------+
- | proofreadpage.py | Objects representing objects used with ProofreadPage
|
- | | Extension
|
-
+---------------------------+-------------------------------------------------------+
- | site.py | Objects representing MediaWiki sites (wikis)
|
-
+---------------------------+-------------------------------------------------------+
- | site_detect.py | Classes for detecting a MediaWiki site
|
-
+---------------------------+-------------------------------------------------------+
- | specialbots.py | Predefined special bot classes
|
-
+---------------------------+-------------------------------------------------------+
- | textlib.py | Functions for manipulating wiki-text
|
-
+---------------------------+-------------------------------------------------------+
- | throttle.py | Mechanics to slow down wiki read and/or write rate
|
-
+---------------------------+-------------------------------------------------------+
- | titletranslate.py | Rules and tricks to auto-translate wikipage titles
|
- | | articles.
|
-
+---------------------------+-------------------------------------------------------+
- | version.py | Module to determine the pywikibot version (tag,
|
- | | revision and date)
|
-
+---------------------------+-------------------------------------------------------+
- | weblib.py | Functions for manipulating external links or querying
|
- | | third-party sites
|
-
+---------------------------+-------------------------------------------------------+
- | xmlreader.py | Reading and parsing XML dump files.
|
-
+---------------------------+-------------------------------------------------------+
-
-
-
+---------------------------+-------------------------------------------------------+
- | comms | Communication layer.
|
-
+===========================+=======================================================+
- | eventstreams.py | stream client for server sent events
|
-
+---------------------------+-------------------------------------------------------+
- | http.py | Basic HTTP access interface
|
-
+---------------------------+-------------------------------------------------------+
- | threadedhttp.py | Httplib2 threaded cookie layer extending httplib2
|
-
+---------------------------+-------------------------------------------------------+
-
-
-
+---------------------------+-------------------------------------------------------+
- | compat | Package to provide compatibility with compat scripts.
|
- | | (should never be used)
|
-
+===========================+=======================================================+
- | catlib.py | Library routines written especially to handle
|
- | | category pages and recurse over category contents.
|
-
+---------------------------+-------------------------------------------------------+
- | query.py | API query library
|
-
+---------------------------+-------------------------------------------------------+
- | userlib.py | Library to work with users, their pages and talk page
|
-
+---------------------------+-------------------------------------------------------+
-
-
-
+---------------------------+-------------------------------------------------------+
- | data | Module providing several layers of data access to
wiki|
-
+===========================+=======================================================+
- | api.py | Interface to Mediawiki's api.php
|
-
+---------------------------+-------------------------------------------------------+
- | mysql.py | Miscellaneous helper functions for mysql queries
|
-
+---------------------------+-------------------------------------------------------+
- | sparql.py | Objects representing SPARQL query API
|
-
+---------------------------+-------------------------------------------------------+
- | wikistats.py | Objects representing WikiStats API
|
-
+---------------------------+-------------------------------------------------------+
-
-
-
+---------------+-------------------------------------------------------------------+
- | tools | Miscellaneous helper functions (not wiki-dependent).
|
-
+===============+===================================================================+
- | __init__.py | several classes and methods
|
-
+---------------+-------------------------------------------------------------------+
- | _logging.py | Logging tools
|
-
+---------------+-------------------------------------------------------------------+
- | chars.py | Character based helper functions(not wiki-dependent)
|
-
+---------------+-------------------------------------------------------------------+
- | djvu.py | Wrapper around djvulibre to access djvu properties and content
|
-
+---------------+-------------------------------------------------------------------+
- | formatter.py | Various formatting related utilities
|
-
+---------------+-------------------------------------------------------------------+
- | ip.py | IP address tools module
|
-
+---------------+-------------------------------------------------------------------+
-
-
-
+-----------------------------------------------------------------------------------+
- | User Interface
|
-
+============================+======================================================+
- | cgi_interface.py | CGI user interface
|
-
+----------------------------+------------------------------------------------------+
- | gui.py | GUI with a unicode textfield where the user can edit
|
-
+----------------------------+------------------------------------------------------+
- | terminal_interface.py | Platform independent terminal interface module
|
-
+----------------------------+------------------------------------------------------+
- | terminal_interface_base.py | Base for terminal user interfaces
|
-
+----------------------------+------------------------------------------------------+
- | terminal_interface_unix.py | User interface for unix terminals
|
-
+----------------------------+------------------------------------------------------+
- | terminal_interface_win32.py| User interface for Win32 terminals
|
-
+----------------------------+------------------------------------------------------+
- | transliteration.py | Module to transliterate text
|
-
+----------------------------+------------------------------------------------------+
- | win32_unicode.py | Stdout, stderr and argv support for unicode
|
-
+----------------------------+------------------------------------------------------+
-
-
-
+-----------------------------------------------------------------------------------+
- | Others
|
-
+============================+======================================================+
- | families (folder) | Contains wiki-specific information like URLs,
|
- | | languages, encodings etc.
|
-
+----------------------------+------------------------------------------------------+
- | README.rst | This file ( Short info on all modules )
|
-
+----------------------------+------------------------------------------------------+
+.. include:: CONTENT.rst
**External software can be used with Pywikibot:**
* Pydot, Pyparsing and Graphviz for use with interwiki_graph.py
diff --git a/setup.py b/setup.py
index de64c83..f15f1de 100644
--- a/setup.py
+++ b/setup.py
@@ -201,12 +201,14 @@
version = version + "-dev"
github_url = 'https://github.com/wikimedia/pywikibot-core'
+with open('README.rst') as f:
+ long_description = f.read()
setup(
name=name,
version=version,
description='Python MediaWiki Bot Framework',
- long_description=open('pypi_description.rst').read(),
+ long_description=long_description,
keywords=('pywikibot', 'python', 'mediawiki', 'bot',
'wiki', 'framework',
'wikimedia', 'wikipedia', 'pwb',
'pywikipedia', 'API'),
maintainer='The Pywikibot team',
--
To view, visit
https://gerrit.wikimedia.org/r/375541
To unsubscribe, visit
https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: Ibca3cc0f545d6481f6c3427b5d14a4e7f7aadf86
Gerrit-PatchSet: 6
Gerrit-Project: pywikibot/core
Gerrit-Branch: master
Gerrit-Owner: Xqt <info(a)gno.de>
Gerrit-Reviewer: Dalba <dalba.wiki(a)gmail.com>
Gerrit-Reviewer: John Vandenberg <jayvdb(a)gmail.com>
Gerrit-Reviewer: Magul <tomasz.magulski(a)gmail.com>
Gerrit-Reviewer: Merlijn van Deen <valhallasw(a)arctus.nl>
Gerrit-Reviewer: Xqt <info(a)gno.de>
Gerrit-Reviewer: jenkins-bot <>