User:KBach-WMF/Collections/PywikibotCollection/Content

This page is related to a project that has now concluded (phab:T320625) and is only retained for archival purposes. Information on this page might be inaccurate.

This page lists and describes pages and resources in the Pywikibot collection. See User:KBach-WMF/Collections/PywikibotCollection for more general information.

Pages on MW

Pywikibot
Quick overview Installation Running on PAWS Running on Windows Running on Toolforge Configuration and scripts user-config.py Global options Generator and filter options i18n Scripts Uses Cookbook Wikidata Non-Wikimedia wikis Development Further help More... »

Some of these pages are included in the menu on the right.

Manual

• Manual:Pywikibot - landing page
• Manual:Pywikibot/Overview - what is Pywikibot?
• Manual:Pywikibot/Installation - installation landing page and instructions for local setup
  • Manual:Pywikibot/Installation/Toolforge - actually redirects to this page on Wikitech
  • Manual:Pywikibot/Installation/SVN - installation using SVN
  • Manual:Pywikibot/Installation/Labs - redirects to Toolforge installation page
• Manual:Pywikibot/PAWS - running on PAWS. Links to PAWS documentation on Wikitech for more information.
• Manual:Pywikibot/Windows - running on Windows
• Manual:Pywikibot/Scripts - scripts landing page. Most scripts have their own pages and links to source code (with in-code documentation, which in turn is included in static documentation).
  • Manual:Pywikibot/Scripts/script - script information template used on script pages.
• Manual:Pywikibot/*.py - script description page
• Manual:Pywikibot/user-config.py - user configuration
• Manual:Pywikibot/Global Options - global options that override user configuration
• Manual:Pywikibot/Page Generators - generators and filters for some bots
• Manual:Pywikibot/Page generators - redirects to Page Generators.
• Manual:Pywikibot/Create your own script - instructions on how to write your own script.
• Manual:Pywikibot/i18n - internationalization
• Manual:Pywikibot/Development development information (documentation - links to static documentation, working with source code, reporting bugs).
  • Manual:Pywikibot/Development/Guidelines
• Manual:Pywikibot/Development guideline - redirects to Development/Guidelines.
• Manual:Pywikibot/Development guidelines - redirects to Development/Guidelines.
• Manual:Pywikibot/Guidelines - redirects to Development/Guidelines.
• Manual:Pywikibot/Test coverage - automated tests
• Manual:Pywikibot/mitmproxy - debugging network issues with mitmproxy
• Manual:Pywikibot/Compat and Pywikibot/Compat/* - documentation for Pywikibot compat (deprecated)
• Manual:Pywikibot/2.0 and Pywikibot/2.0 - Pywikibot rewrite documentation. Status unknown.
• Manual:Pywikibot/BotPasswords - alternative bot authentication mechanism
• Manual:Pywikibot/Communication - communication channels
• Manual:Pywikibot/Basic use - redirects to a compat-related page.
• Manual:Pywikibot/Code of conduct RFC - redirects to Code of conduct RFC project page
• Manual:Pywikibot/Compatibility - Python and MediaWiki compatibility information
• Manual:Pywikibot/Compatibility Graph - compatibility information graph included on the Compatibility page.
• Manual:Pywikibot/Compatibility Table - compatibility information table included on the Compatibility page.
• Manual:Pywikibot/Version table - Python support table included on the Compatibility page.
• Manual:Pywikibot/Documentation RFC - redirects to Documentation RFC project page.
• Manual:Pywikibot/Errors - error troubleshooting information. Very little content.
• Manual:Pywikibot/Flow - information about support for the Flow extension. Note that Flow (also known as Structured Discussions) is deprecated (see Extension:StructuredDiscussions).
• Manual:Pywikibot/Gerrit - information on how to use Gerrit for Pywikibot development.
• Manual:Pywikibot/History - some information on project history
• Manual:Pywikibot/Mac - redirects to Pywikibot installation instructions
• Manual:Pywikibot/Migrating to bugzilla - redirects to migration information project page.
• Manual:Pywikibot/MySQL - information about basic support for querying MySQL databases.
• Manual:Pywikibot/OAuth - information about OAuth authentication support. Links to OAuth/For Developers - a more detailed article about using MediaWiki as an OAuth server.
  • Manual:Pywikibot/OAuth/Wikimedia - using OAuth to authenticate with Wikimedia wikis.
• Manual:Pywikibot/Quick Start Guide - redirects to Third-party Wiki Quick Start
• Manual:Pywikibot/Third-party Wiki Quick Start - information on using Pywikibot with a non-Wikimedia wiki. Links to Use on third-party wikis.
• Manual:Pywikibot/Use on third-party wikis - a more detailed guide on using Pywikibot with non-Wikimedia wikis. Marked as outdated.
• Manual:Pywikibot/Recipes - framework usage examples as code snippets. Stalled.
• Manual:Pywikibot/Survey2012 - redirects to 2012 survey project page
• Manual:Pywikibot/Use on non-WMF wikis - redirects to Use on third-party wikis.
• Manual:Pywikibot/Use on non-Wikimedia foundation wikis - redirects to Use on third-party wikis.
• Manual:Pywikibot/User-agent - using a custom user agent.
• Manual:Pywikibot/Version - redirects to Pywikibot version table.
• Manual:Pywikibot/Versions - redirects to Pywikibot version table.
• Manual:Pywikibot/WD - redirects to Wikidata.
• Manual:Pywikibot/Wikidata - how to create bots on Wikidata.
• Manual:Pywikibot/Wikidata/Rewrite proposal - redirects to Wikidata rewrite proposal.
• Manual:Pywikibot/compat-to-core conversion - information on how to convert bots from version 1 to version 3
• Manual:Pywikibot/login - redirect to a script page.
• Manual:Pywikibot/refLinks - description of the reflinks functionality provided by DumZiBoT.
• Manual:Pywikibot/reflinks - redirects to refLinks
• Manual:Pywikibot/timeline - project timeline used on the landing page
• Manual:Pywikibot/styles.css - stylesheet, apparently used for MediaWiki/Homepage improvements 2018? Status unknown.

Project

• Project:Pywikibot/Code of conduct RFC - code of conduct proposal and discussion. Archived - belongs to.
• Project:Pywikibot/Documentation RFC - documentation restructuring proposal and discussion. Archived - belongs to.
• Project:Pywikibot/Migrating to bugzilla - historical information about migrating to bugzilla
• Project:Pywikibot/Survey2012 - Python version usage survey from 2012.
• Project:Pywikibot/Wikidata/Rewrite proposal - datapage/relevant class rewrite proposal. Archived.

Categories

• Category:Pywikibot archive - archived pages

Pages on Wikitech

• Wikitech:Help:Toolforge/Pywikibot - Pywikibot setup instructions for Toolforge. Incomplete and potentially inaccurate as per task T134495.
• Wikitech:Help:Toolforge/My_first_Pywikibot_tool - Marked for merging with Toolforge/Pywikibot
• Wikitech:User:Russell_Blau/Using_pywikibot_on_Labs - setting up a tool to run the core branch of pywikibot on the 'Tools' project.
• Wikitech:PAWS/PAWS and Pywikibot - general information on PAWS and Pywikibot, and links to tutorial notebooks.
• Wikitech:PAWS/PAWS examples and recipes#Pywikibot_(Uses_MediaWiki_API) - list of Pywikibot examples and recipes hosted on PAWS.

Pages on Wikidata

• Wikidata:Help:Pywikibot - Pywikibot landing page for Wikidata
• Wikidata:Wikidata:Creating a bot#Pywikibot - Pywikibot instructions for Wikidata
• Wikidata:Wikidata:Pywikibot - Python 3 Tutorial - Pywikibot Python 3 tutorial for Wikidata
  • Wikidata:Wikidata:Pywikibot - Python_3_Tutorial/Setting_up_Shop - local installation instructions
  • Wikidata:Wikidata:Pywikibot - Python 3 Tutorial/Data Harvest - gathering data
  • Wikidata:Wikidata:Pywikibot - Python 3 Tutorial/Winter Storage - storing data
  • Wikidata:Wikidata:Pywikibot - Python 3 Tutorial/Big Data - gathering MORE data
  • Wikidata:Wikidata:Pywikibot - Python_3_Tutorial/Changing_Items - replacing incorrect data
  • Wikidata:Wikidata:Pywikibot - Python 3 Tutorial/Create Items - creating data
  • Wikidata:Wikidata:Pywikibot - Python 3 Tutorial/Danger Zone - making sure you are editing test.wikidata.org
  • Wikidata:Wikidata:Pywikibot - Python 3 Tutorial/Gathering data from Arabic-Wikipedia - gathering data from wikis that use right-to-left writing systems
  • Wikidata:Wikidata:Pywikibot - Python 3 Tutorial/Iterate over a SPARQL query - iterating over a SPARQL query results
  • Wikidata:Wikidata:Pywikibot - Python 3 Tutorial/Labels - editing labels, aliases, descriptions
  • Wikidata:Wikidata:Pywikibot - Python 3 Tutorial/Lexeme - adding, editing, finding lexemes (work in progress)
  • Wikidata:Wikidata:Pywikibot - Python 3 Tutorial/Machine learning with Wikidata - machine learning algorithms and training models on data from Wikidata
  • Wikidata:Wikidata:Pywikibot - Python 3 Tutorial/Page views - getting page view information
  • Wikidata:Wikidata:Pywikibot - Python 3 Tutorial/Quantities and Units - adding data to items
  • Wikidata:Wikidata:Pywikibot - Python 3 Tutorial/Setting qualifiers - modifying qualifiers
  • Wikidata:Wikidata:Pywikibot - Python 3 Tutorial/Setting sitelinks - modifying sitelinks
  • Wikidata:Wikidata:Pywikibot - Python 3 Tutorial/Setting sources - modifying sources
  • Wikidata:Wikidata:Pywikibot - Python 3 Tutorial/Setting statements - modifying statements
  • Wikidata:Wikidata:Pywikibot - Python 3 Tutorial/Talk Page Messages - posting messages and templates on talk pages
  • Wikidata:Wikidata:Pywikibot - Python 3 Tutorial/Templates - scanning for templates
  • Wikidata:Wikidata:Pywikibot - Python 3 Tutorial/Templates, Generators, Tables - iterating over template usage with a generator function
  • Wikidata:Wikidata:Pywikibot - Python 3 Tutorial/linked pages - getting linked pages from items

Resources on other wikis

• meta:Category:Pywikibot - pages related to Pywikibot on Meta.
• commons:Category:Pywikibot - some media resources, especially video, that could be useful for some users
• commons:Category:Pywikibot scripts - bot scripts with public source code

Static documentation

• https://doc.wikimedia.org/pywikibot/
  • https://doc.wikimedia.org/pywikibot/master/ - main development branch
  • https://doc.wikimedia.org/pywikibot/stable/ - documentation for the current release
  • https://doc.wikimedia.org/pywikibot/tests/ - documentation for test - looks outdated

Static documentation pages

• Installation - installation instructions slightly different from those on MediaWiki. The latter installs Pywikibot using pip but usage instructions require direct access to pwb.py from the zip file or code cloned from repository. The former additionally contains instructions on basic usage, settings.
• Utility scripts - introduction to utility script usage. Only covers login, preload_sites, shell, version, generate_family_file, and some basic wrapper options. Content automatically generated from code.
• Utility scripts - similar to Utility scripts introduction, but more extensive, with class and function specifications. Content automatically generated from code.
• Scripts package - Bundled scripts list. Vaguely equivalent to the Scripts page. Script descriptions are grouped - group pages are located in scripts/*.
• Global Options - List of arguments available for all bots. The same as Global Options on MediaWiki. Automatically generated.
• Frequent Asked Questions
• Getting help - Links to Communication. Also mentions reporting bugs in Phabricator.
• Using pywikibot as library - information on how to create your own script using bot classes provided by Pywikibot.
• Recipes - similar to #mediawiki-recipes Recipes on MediaWiki, one overlapping recipe, one new recipe.
• API reference - full Pywikibot reference, starting point for automatically generated API docs from https://doc.wikimedia.org/pywikibot/master/api_ref/*.
• Scripts Reference - complete script reference, an index to docs in scripts_ref/*. Documentation generated from code.
• Tests Reference - test reference and instructions on running tests. Much broader scope than Test coverage on MediaWiki.
• scripts.maintenance utility scripts - documentation for maintenance scripts automatically generated from code.
• Installer Scripts - documentation on how to create new distributions. Automatically generated from code.
• Glossary - basic terminology information.
• Change log - detailed version history
• Licenses
• Credits

Small wiki toolkits workshops

• Meta:Small_wiki_toolkits/Workshops

Phabricator

• Main Pywikibot development board
• Main Pywikibot development board (direct link using board ID)
• Pywikibot scripts board
• Pywikibot commons board
• Pywikibot documentation tasks

Toolhub

• https://toolhub.wikimedia.org/tools/pywikibot
• https://toolhub.wikimedia.org/tools/toolforge-pywikibot

PAWS notebooks

• PAWS & Pywikibot tutorial - notebook-based introduction to Pywikibot with Python 3 on PAWS. Introduced and linked from PAWS and Pywikibot. Some of the links in this notebook don't work, some work but the scripts they link to produce errors.
• Wikidata Pywikibot Tutorial - a summary of Wikidata:Pywikibot - Python 3 Tutorial. Introduced and linked from PAWS and Pywikibot. It is recommended you read the tutorials before using it.

Outside the collection, but potentially relevant

• Manual:Creating a bot - general considerations related to bot creation and usage
• w:Help:Creating a bot - broader discussion about bot creation and usage on Wikipedia
• meta:Bot policy - bot policy and guidelines
  • wikidata:Wikidata:Bots - bot policy on Wikidata
  • w:Wikipedia:Bot policy - bot policy on English Wikipedia
• meta:Bot - general information about bots

Historical records, discussions, evaluations

• Git/Conversion/pywikibot
• API:Client code/Evaluations/Pywikibot

Other

• Pywikibot documentation Jenkins job
• pywikibot.org(pywikibot.toolforge.org)