Help:Toolforge/My first Pywikibot tool

From Wikitech
Jump to navigation Jump to search

Warning Caution: This page may contain inaccuracies. It is currently being edited and redesigned for better readability. For further information, please see T134495.

This page is related to https://wikitech.wikimedia.org/wiki/Help:Toolforge/Pywikibot. These pages will be combined for simpler documentation

Pywikibot is a Python library which automates work on MediaWiki sites. Use this guide to create your own tool based on Pywikibot and host it on the Toolforge hosting enviornment.

Before you start

Before creating your tool, you must have created initial account setup and be able to access Toolforge, via Toolsadmin and SSH. To do that, follow the instructions at Help:Toolforge/Quickstart.

Create your Pywikibot Tool account

In addition to your own Toolforge account, you also need to create a Tool acoount for your Pywikibot tool.

  1. Navigate to the Create Tool Account page in the Toolforge admin console.
  2. Enter a Unique Tool Name for your tool account.
    Do not prefix your tool name with tools. as this prefix will cause errors.

Note: If you only recently received access to the tools project, you may get an error about appropriate credentials. Log out and back in to fix the issue.

Within a minute or two, Toolforge creates the Tool account and grants you access. If you were logged in through ssh when you created the Tool account, you must log off and log in again

Access your Pywikibot tool

After you create your Pywikibot's tool account, you can log into your tool project with SSH.

$ ssh <unix shell username>@login.toolforge.org

From the command line, switch to your tool account:

become <toolname>

You should see the command prompt change to:

tools.<toolname>@tools-bastion:~$

Now, you can install Pywikibot.

Install Pywikibot

Main article: Help:Toolforge/Pywikibot#Installation and setup

Choose a license

Pywikibot comes with an MIT LICENSE file. Make sure to choose a license for your tool early on. Also see Help:Toolforge/Developing successful tools#Pick a license


Communication and support

Support and administration of the WMCS resources is provided by the Wikimedia Foundation Cloud Services team and Wikimedia movement volunteers. Please reach out with questions and join the conversation:

Discuss and receive general support
Stay aware of critical changes and plans
Track work tasks and report bugs

Use a subproject of the #Cloud-Services Phabricator project to track confirmed bug reports and feature requests about the Cloud Services infrastructure itself

Read stories and WMCS blog posts

Read the Cloud Services Blog (for the broader Wikimedia movement, see the Wikimedia Technical Blog)