Help:Tool Labs/My first Pywikibot tool

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 Tool Labs.

Tool Labs account required: Before creating your tool, you need to create an account to access Tool Labs. Set up your user name and shell name and submit a Tool Labs project membership request.

Access your Pywikibot tool

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

$ ssh <shell name>@login.tools.wmflabs.org

Switch to your tool account:

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

Now, you can install Pywikibot.

Install Pywikibot

Using your tool account run the following:

1. Use git to download Pywikibot:

   git clone --recursive https://gerrit.wikimedia.org/r/pywikibot/core.git

2. Set up your bot for selected wikis by running:

   python generate_user_files.py