WikiRobots

From FreeCAD Documentation
Revision as of 17:48, 8 November 2013 by Ediloren (talk | contribs) (Creation)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Robots are intrinsically dangerous as they can automatically do a lot of damage. Use with extreme care!

Overview

Repetitive tasks can be automated using Robots, i.e. software programs operating on the Wiki.

The natural and most used Robots for Wiki sites are provided by Wikipedia, under the name of Pywikibot.

In a nutshell, the Pywikibot is a collection of Python scripts able to use the native Wiki API to act on the Wiki sites (to see for instance the API list for FreeCAD Wiki, select this link http://www.freecadweb.org/wiki/api.php).

In order to use the Pywikibot, you need to:

  1. install the Pywikibot
  2. configure the Pywikibot to work on the FreeCAD Wiki
  3. launch the script(s) you need for the task at hand

There is a wealth of information on how to install, configure and use the Pywikibot. However, please be aware that this information, although useful, can be highly misleading, since it is mixing instructions related to two different Pywikibot codebases, and different versions of the Pywikibot scripts collection.

In the following, you will find the basic instructions to set up and use Pywikibot on FreeCAD wiki. This will allow you to perform most of the tasks. For more detailed information and advanced usage, you'll have eventually to refer to the Pywikibot manual and, even better, to the Python source code / source code comments.