You are browsing a read-only backup copy of Wikitech. The live site can be found at wikitech.wikimedia.org

Help:Tool Labs/My first Pywikibot tool: Difference between revisions

From Wikitech-static
Jump to navigation Jump to search
imported>Xephyr826
imported>BryanDavis
 
Line 1: Line 1:
{{draft}}
#REDIRECT [[Help:Toolforge/My first Pywikibot tool]]
[[mw:Manual:Pywikibot|Pywikibot]] is a [[w:Python_(programming_language)|Python]] library which automates work on MediaWiki sites. Use this guide to create your own tool based on Pywikibot and host it on [[Help:Tool_Labs|Tool Labs]].
 
__TOC__
 
'''Tool Labs account required:'''
Before creating your tool, you need to [[Help:Tool_Labs/Getting_started#Creating_your_account|create an account to access Tool Labs]]. Set up your user name and shell name and submit a [https://toolsadmin.wikimedia.org/tools/membership/apply Tool Labs project membership request].
 
==Create your Pywikibot Tool account==
In addition to your own Tool Labs account, you also need to create a [[Help:Tool_Labs#Joining_and_creating_a_Tool_account|Tool acoount]] for your Pywikibot tool.
 
# Navigate to the [[toollabs:|Tools home page]].
# Click '''Create a New Tool''' under '''Develop your own tool'''.
# Enter a Service group name. The Service group name will become the name of your tool account.<br/> Do not prefix your service group name with <code>tools.</code>. This prefix will cause an improperly created account. The management interface automatically adds this prefix where appropriate.
 
'''Note:''' If you only recently received access to the tools project, you may get an error about appropriate credentials. Log out of Wikitech and back in to fix the issue.
 
Within a minute or two, Tool Labs 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.
 
<source >
$ ssh <shell name>@login.tools.wmflabs.org
</source>
 
Switch to your tool account:
 
<source>
maintainer@tools-bastion:~$ become <toolname>
tools.<toolname>@tools-bastion:~$
</source>
 
Now, you can install Pywikibot.
 
==Install Pywikibot==
Using your tool account, do the following:
 
<ol>
<li>Use git to download Pywikibot:
<source>
git clone --recursive https://gerrit.wikimedia.org/r/pywikibot/core.git pywikibot-core
cd pywikibot-core
</source>
</li>
<li>
Set up your bot for selected wikis by running:
<source>
python generate_user_files.py
</source>
</li>
</ol>
 
==Choose a license==
Pywikibot comes with an MIT <tt>LICENSE</tt> file. Make sure to choose a license for your tool early on. Also see, [[Help:Tool_Labs/Developing#Licensing_your_source_code]]
 
==Publish your source code==
 
==Create a documentation page==
 
 
===Create a documentation page for your tool===
 
===Set up a webpage for your tool===
You can add webpage for your tool under http://tools.wmflabs.org/TOOLNAME. For example, http://tools.wmflabs.org/my-first-pywikibot-tool. Once you set up a webpage for your tool, the [https://tools.wmflabs.org/?list Tool list] will link to it.
 
To set up webpage for you tool:
 
# Log in with your Tool account.
# Create a <tt>~/public_html</tt> directory.
# Create <tt>~/public_html/index.html</tt>.
# Start the web service:
<pre>
$ webservice start
</pre>

Latest revision as of 18:47, 14 July 2017