[Pywikibot-commits] [Gerrit] Providing README.rst in scripts and pywikibot. - change (pywikibot/core)

jenkins-bot has submitted this change and it was merged. Change subject: Providing README.rst in scripts and pywikibot. ...................................................................... Providing README.rst in scripts and pywikibot. This includes description of existing libraries and scripts in core. Since many scripts which are part of compat and needs migration their details are also mentioned with #at their beginning. Besides, the README.rst in pywikibot-core is updated. Signed-off-by: xqt &lt;info(a)gno.de&gt; Bug:T66847 Change-Id: I3e1a36826167f92502451593565fa719af03ae5e --- M README.rst A pywikibot/README.rst A scripts/README.rst 3 files changed, 562 insertions(+), 2 deletions(-) Approvals: Ladsgroup: Looks good to me, approved Xqt: Looks good to me, but someone else must approve jenkins-bot: Verified diff --git a/README.rst b/README.rst index 08a1991..65ed818 100644 --- a/README.rst +++ b/README.rst @@ -30,8 +30,8 @@ guide <https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Pywikibot/Installation>`_ has more details for advanced usage. -Usage ------ +Basic Usage +----------- If you wish to write your own script it's very easy to get started: @@ -43,6 +43,54 @@ 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 +---------------------------- + + +----------------------------------------------------------------------------------+ + | 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 2 | + +---------------------------+------------------------------------------------------+ + | README.rst | Short info string used by Pywikibot Nightlies | + +---------------------------+------------------------------------------------------+ + | requirements.txt | PIP requirements file | + +---------------------------+------------------------------------------------------+ + | setup.py | Installer script for Pywikibot 2.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 | + +---------------------------+------------------------------------------------------+ + + Required external programms --------------------------- diff --git a/pywikibot/README.rst b/pywikibot/README.rst new file mode 100644 index 0000000..1397683 --- /dev/null +++ b/pywikibot/README.rst @@ -0,0 +1,224 @@ +========================================================================= +**This is a package to build robots for MediaWiki wikis like Wikipedia.** +========================================================================= + + +Please do not play with this package. +------------------------------------- +These programs can actually modify the live wiki on the net, and proper +wiki-etiquette should be followed before running it on any wiki. + +To get started on proper usage of the bot framework, please refer to: + + `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 | + +---------------------------+------------------------------------------------------+ + | 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 | + +---------------------------+------------------------------------------------------+ + | 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. | + +===========================+======================================================+ + | http.py | Basic HTTP access interface | + +---------------------------+------------------------------------------------------+ + | rcstream.py | SocketIO-based rcstream client | + +---------------------------+------------------------------------------------------+ + | 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 | + +---------------------------+-------------------------------------------------------+ + | wikidataquery.py | Objects representing WikidataQuery query syntax | + | | and 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 ) | + +----------------------------+------------------------------------------------------+ + +**External software can be used with Pywikibot:** + * Pydot, Pyparsing and Graphviz for use with interwiki_graph.py + * JSON for use with site.py, bot.py + * MySQLdb to access MySQL database for use with pagegenerators.py + * PyGoogle to access Google Web API and PySearch to access Yahoo! Search + Web Services for use with pagegenerators.py + + +Pywikibot makes use of some modules that are part of python, but that +are not installed by default on some Linux distributions: + + * python-xml (required to parse XML via SaX2) + * python-celementtree (recommended if you use XML dumps) + * python-tkinter (optional, used by some experimental GUI stuff) + + +You need to have at least python version `2.6.5 <http://www.python.org/download/>`_ +or newer installed on your computer to be able to run any of the code in this +package, but not 3.0-3.2. It works fine with 3.3-3.4 versions of python installed. +Support for older versions of python is not planned. Some scripts could run with +older python releases. Please refer the manual at mediawiki for further details +and restrictions. + + +You do not need to "install" this package to be able to make use of +it. You can actually just run it from the directory where you unpacked +it or where you have your copy of the SVN or git sources. + + +The first time you run a script, the package creates a file named user-config.py +in your current directory. It asks for the family and language code you are +working on and at least for the bot's user name; this will be used to identify +you when the robot is making changes, in case you are not logged in. You may +choose to create a small or extended version of the config file with further +informations. Other variables that can be set in the configuration file, please +check config.py for ideas. + + +After that, you are advised to create a username + password for the bot, and +run login.py. Anonymous editing is not possible. diff --git a/scripts/README.rst b/scripts/README.rst new file mode 100644 index 0000000..8f9153b --- /dev/null +++ b/scripts/README.rst @@ -0,0 +1,288 @@ +=========================================================================== +**This is a package to include robots for MediaWiki wikis like Wikipedia.** +=========================================================================== + +Some example robots are included. +--------------------------------- + +These programs can actually modify the live wiki on the net, and proper +wiki-etiquette should be followed before running it on any wiki. + +To get started on proper usage of the bot framework, please refer to: + + `Manual:Pywikibot <http://www.mediawiki.org/wiki/Manual:Pywikibot>`_ + +NOTE : Script names with # at start are not yet present in Core rather are + expected to be merged based on reviews and need from Compat version. + +The contents of the package +--------------------------- + + +----------------------------------------------------------------------------------+ + | Bots and Scripts | + +========================+=========================================================+ + | add_text.py | Adds text at the top or end of pages. | + +------------------------+---------------------------------------------------------+ + | basic.py | Is a template from which simple bots can be made. | + +------------------------+---------------------------------------------------------+ + | blockpagechecker.py | Deletes any protection templates that are on pages | + | | which aren't actually protected. | + +------------------------+---------------------------------------------------------+ + | blockreview.py | Bot implements blocking review process for de-wiki first| + +------------------------+---------------------------------------------------------+ + | capitalize_redirects.py| Script to create a redirect of capitalize articles. | + +------------------------+---------------------------------------------------------+ + | casechecker.py | Script to enumerate all pages in the wikipedia and | + | | find all titles with mixed Latin and Cyrillic | + | | alphabets. | + +------------------------+---------------------------------------------------------+ + | catall.py | Add or change categories on a number of pages. | + +------------------------+---------------------------------------------------------+ + | category.py | Add a category link to all pages mentioned on a page, | + | | change or remove category tags | + +------------------------+---------------------------------------------------------+ + | category_redirect.py | Maintain category redirects and replace links to | + | | redirected categories. | + +------------------------+---------------------------------------------------------+ + | #censure.py | Bad word checker bot. | + +------------------------+---------------------------------------------------------+ + | cfd.py | Processes the categories for discussion working page. | + | | It parses out the actions that need to be taken as a | + | | result of CFD discussions and performs them. | + +------------------------+---------------------------------------------------------+ + | checkimages.py | Check recently uploaded files. Checks if a file | + | | description is present and if there are other problems | + | | in the image's description. | + +------------------------+---------------------------------------------------------+ + | claimit.py | Adds claims to Wikidata items based on categories | + +------------------------+---------------------------------------------------------+ + | clean_sandbox.py | This bot makes the cleaned of the page of tests. | + +------------------------+---------------------------------------------------------+ + | commons_link.py | This robot include commons template to linking Commons | + | | and your wiki project. | + +------------------------+---------------------------------------------------------+ + | commonscat.py | Adds {{commonscat}} to Wikipedia categories (or | + | | articles), if other language wikipedia already has such | + | | a template | + +------------------------+---------------------------------------------------------+ + | #copyright.py | This robot check copyright text in Google, Yahoo! and | + | | Live Search. | + +------------------------+---------------------------------------------------------+ + | #copyright_clean.py | Remove reports of copyright.py on wiki pages. | + | | Uses YurikAPI. | + +------------------------+---------------------------------------------------------+ + | #copyright_put.py | Put reports of copyright.py on wiki pages. | + +------------------------+---------------------------------------------------------+ + | coordinate_import.py | Coordinate importing script. | + +------------------------+---------------------------------------------------------+ + | cosmetic_changes.py | Can do slight modifications to a wiki page source code | + | | such that the code looks cleaner. | + +------------------------+---------------------------------------------------------+ + | create_categories.py | Program to batch create categories. | + +------------------------+---------------------------------------------------------+ + | data_ingestion.py | A generic bot to do batch uploading to Commons. | + +------------------------+---------------------------------------------------------+ + | delete.py | This script can be used to delete pages en masse. | + +------------------------+---------------------------------------------------------+ + | disambredir.py | Changing redirect names in disambiguation pages. | + +------------------------+---------------------------------------------------------+ + | djvutext.py | Extracts OCR text from djvu files and uploads onto | + | | pages in the "Page" namespace on Wikisource. | + +------------------------+---------------------------------------------------------+ + | editarticle.py | Edit a Wikipedia article with your favourite editor | + +------------------------+---------------------------------------------------------+ + | featured.py | A robot to check feature articles. | + +------------------------+---------------------------------------------------------+ + | fixing_redirects.py | Correct all redirect links of processed pages. | + +------------------------+---------------------------------------------------------+ + | flickrripper.py | Upload images from Flickr easily. | + +------------------------+---------------------------------------------------------+ + | #followlive.py | follow new articles on a wikipedia and flag them | + | | with a template. | + +------------------------++--------------------------------------------------------+ + | freebasemappingupload.py| Docstring fixes in scripts | + +------------------------++--------------------------------------------------------+ + | harvest_template.py | [IMPROV] Reduce maximum line length to 130 | + +------------------------+---------------------------------------------------------+ + | illustrate_wikidata.py | Dont use 'gen' to refer to the generator factory | + +------------------------+---------------------------------------------------------+ + | image.py | This script can be used to change one image to another | + | | or remove an image entirely. | + +------------------------+---------------------------------------------------------+ + | imagecopy.py | Copies images from a wikimedia wiki to Commons | + +------------------------+---------------------------------------------------------+ + | imagecopy_self.py | Copy self published files from the English Wikipedia to | + | | Commons. | + +------------------------+---------------------------------------------------------+ + | imageharvest.py | Bot for getting multiple images from an external site. | + +------------------------+---------------------------------------------------------+ + | iamgerecat.py | Try to find categories for media on Commons. | + +------------------------+---------------------------------------------------------+ + | imagetransfer.py | Given a wiki page, check the interwiki links for | + | | images, and let the user choose among them for | + | | images to upload. | + +------------------------+---------------------------------------------------------+ + | imageuncat.py | Adds uncat template to images without categories at | + | | Commons | + +------------------------+---------------------------------------------------------+ + | #inline_images.py | This bot looks for images that are linked inline | + | | (i.e., they are hosted from an external server and | + | | hotlinked). | + +------------------------+---------------------------------------------------------+ + | interwiki.py | A robot to check interwiki links on all pages (or | + | | a range of pages) of a wiki. | + +------------------------+---------------------------------------------------------+ + | isbn.py | Bot to convert all ISBN-10 codes to the ISBN-13 | + | | format. | + +------------------------+---------------------------------------------------------+ + | listpages.py | listpages: report number of pages found | + +------------------------+---------------------------------------------------------+ + | login.py | [IMPROV] Reduce maximum line length to 130 | + +------------------------+---------------------------------------------------------+ + | lonelypages.py | Place a template on pages which are not linked to by | + | | other pages, and are therefore lonely | + +------------------------+---------------------------------------------------------+ + | makecat.py | Given an existing or new category, find pages for that | + | | category. | + +------------------------+---------------------------------------------------------+ + | match_images.py | Match two images based on histograms. | + +------------------------+---------------------------------------------------------+ + | misspelling.py | Similar to solve_disambiguation.py. It is supposed to | + | | fix links that contain common spelling mistakes. | + +------------------------+---------------------------------------------------------+ + | movepages.py | Bot page moves to another title. | + +------------------------+---------------------------------------------------------+ + | #ndashredir.py | Creates hyphenated redirects to articles with n dash | + | | or m dash in their title. | + +------------------------+---------------------------------------------------------+ + | newitem.py | Script creates new items on Wikidata based on criteria. | + +------------------------+---------------------------------------------------------+ + | noreferences.py | Searches for pages where <references /> is missing | + | | although a <ref> tag is present, and in that case adds | + | | a new references section. | + +------------------------+---------------------------------------------------------+ + | nowcommons.py | This bot can delete images with NowCommons template. | + +------------------------+---------------------------------------------------------+ + | pagefromfile.py | This bot takes its input from a file that contains a | + | | number of pages to be put on the wiki. | + +------------------------+---------------------------------------------------------+ + | #pageimport.py | Import pages from a certain wiki to another. | + +------------------------+---------------------------------------------------------+ + | panoramiopicker.py | Upload images from Panoramio easily. | + +------------------------+---------------------------------------------------------+ + | patrol.py | Obtains a list pages and marks the edits as patrolled | + | | based on a whitelist. | + +------------------------+---------------------------------------------------------+ + | piper.py | Pipes article text through external program(s) on | + | | STDIN and collects its STDOUT which is used as the | + | | new article text if it differs from the original. | + +------------------------+---------------------------------------------------------+ + | protect.py | Protect and unprotect pages en masse. | + +------------------------+---------------------------------------------------------+ + | redirect.py | Fix double redirects and broken redirects. Note: | + | | solve_disambiguation also has functions which treat | + | | redirects. | + +------------------------+---------------------------------------------------------+ + | reflinks.py | Search for references which are only made of a link | + | | without title and fetch the html title from the link to | + | | use it as the title of the wiki link in the reference. | + +------------------------+---------------------------------------------------------+ + | replace.py | Search articles for a text and replace it by another | + | | text. Both text are set in two configurable | + | | text files. The bot can either work on a set of given | + | | pages or crawl an SQL dump. | + +------------------------+---------------------------------------------------------+ + | replicate_wiki.py | Replicates pages in wiki to a second wiki within family| + +------------------------+---------------------------------------------------------+ + | revertbot.py | Revert edits. | + +------------------------+---------------------------------------------------------+ + | script_wui.py | Fix anomalous escape (\) | + +------------------------+---------------------------------------------------------+ + | selflink.py | This bot goes over multiple pages of the home wiki, | + | | searches for selflinks, and allows removing them. | + +------------------------+---------------------------------------------------------+ + | shell.py | Spawns an interactive Python shell | + +------------------------+---------------------------------------------------------+ + | solve_disambiguation.py| Interactive robot doing disambiguation. | + +------------------------+---------------------------------------------------------+ + | spamremove.py | Remove links that are being or have been spammed. | + +------------------------+--+------------------------------------------------------+ + | standardize_interwiki.py | A robot that downloads a page, and reformats the | + | | interwiki links in a standard way (i.e. move all | + | | of them to the bottom or the top, with the same | + | | separator, in the right order). | + +------------------------+--+------------------------------------------------------+ + | states-redirect.py | A robot to add redirects to cities for state | + | | abbreviations. | + +------------------------+---------------------------------------------------------+ + | #speedy_delete.py | This bot load a list of pages from the category of | + | | candidates for speedy deletion and give the | + | | user an interactive prompt to decide whether | + | | each should be deleted or not. | + +------------------------+---------------------------------------------------------+ + | #spellcheck.py | This bot spellchecks wiki pages. | + +------------------------+---+-----------------------------------------------------+ + | #standardize_notes.py | Converts external links and notes/references to | + | | : Footnote3 ref/note format. Rewrites References. | + +----------------------------+-----------------------------------------------------+ + | #statistics_in_wikitable.py| This bot renders statistics provided by | + | | [[Special:Statistics]] in a table on a wiki page. | + | | Thus it creates and updates a statistics wikitable. | + +----------------------------+-----------------------------------------------------+ + | #table2wiki.py | Semi-automatic converting HTML-tables to wiki-tables| + +------------------------+---+-----------------------------------------------------+ + | template.py | change one template (that is {{...}}) into another. | + +------------------------+---------------------------------------------------------+ + | templatecount.py | Display the list of pages transcluding a given list | + | | of templates. | + +------------------------+---------------------------------------------------------+ + | touch.py | Bot goes over all pages of the home wiki, and edits | + | | them without changing. | + +------------------------+---------------------------------------------------------+ + | transferbot.py | Transfers pages from a source wiki to a target wiki | + +------------------------+---------------------------------------------------------+ + | unlink.py | This bot unlinks a page on every page that links to it. | + +------------------------+---------------------------------------------------------+ + | unusedfiles.py | Bot appends some text to all unused images and other | + | | text to the respective uploaders. | + +------------------------+---------------------------------------------------------+ + | upload.py | upload an image to a wiki. | + +------------------------+---------------------------------------------------------+ + | version.py | Outputs Pywikibot's revision number, Python's version | + | | and OS used. | + +------------------------+---------------------------------------------------------+ + | watchlists.py | Information retrieved by watchlist.py will be stored | + +------------------------+---------------------------------------------------------+ + | weblinkchecker.py | Check if external links are still working. | + +------------------------+---------------------------------------------------------+ + | welcome.py | Script to welcome new users. | + +------------------------+---------------------------------------------------------+ + + + +-----------------------------------------------------------------------------------+ + | archive | Scripts no longer maintained. | + +========================+==========================================================+ + | archivebot.py | Archives discussion threads. | + +------------------------+----------------------------------------------------------+ + + + +-----------------------------------------------------------------------------------+ + | Others | + +========================+==========================================================+ + | i18n (folder) | Contains i18n translations for bot edit summaries. | + +------------------------+----------------------------------------------------------+ + | maintenance (folder) | Contains maintenance scripts for the developing team. | + +------------------------+----------------------------------------------------------+ + | README.rst | This file (Short info of all scripts). | + +------------------------+----------------------------------------------------------+ + +**External software can be used with Pywikibot:** + * PyGoogle to access Google Web API and PySearch to access Yahoo! Search + Web Services for use with copyright.py. + + +More precise information, and a list of the options that are available for +the various programs, can be retrieved by running the bot with the -help +parameter, e.g. + + python pwb.py interwiki.py -help -- To view, visit https://gerrit.wikimedia.org/r/202016 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: I3e1a36826167f92502451593565fa719af03ae5e Gerrit-PatchSet: 10 Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-Owner: Prianka &lt;priyankajayaswal025(a)gmail.com&gt; Gerrit-Reviewer: John Vandenberg &lt;jayvdb(a)gmail.com&gt; Gerrit-Reviewer: Ladsgroup &lt;ladsgroup(a)gmail.com&gt; Gerrit-Reviewer: Merlijn van Deen &lt;valhallasw(a)arctus.nl&gt; Gerrit-Reviewer: Prianka &lt;priyankajayaswal025(a)gmail.com&gt; Gerrit-Reviewer: XZise &lt;CommodoreFabianus(a)gmx.de&gt; Gerrit-Reviewer: Xqt &lt;info(a)gno.de&gt; Gerrit-Reviewer: jenkins-bot <>