Manual:Pywikibot/Development

From MediaWiki.org
Jump to: navigation, search
If you need more help on setting up your Pywikibot visit the IRC channel #pywikibotconnect @ freenode server or Pywikibot mailing list.

How to report a bug[edit | edit source]

When you report a bug, please try to include:

  • What Pywikipediabot version you are using. We recommend that you test if the bug is still present in the latest available revision, as stored in Git.
  • Python version (do python -V to check) and operating system you use (e.g. Windows, Linux, Mac OS...).
  • A nice summary.
  • A full description of the problem/report.
  • How to reproduce the bug, with full information (script, command line, family, and language used).
  • The console output provided by the script (included the Python traceback if you are reporting a crash).

To submit a new bug, visit the bug tracker.

Development[edit | edit source]

If you have thought of a function you want to have, and none of the bots provides it yet, you can ask one of the programmers to write it for you. Or even better, you can try to work on the bots yourself. Python is a nice language, and not hard to learn. We will welcome you.

Commit access[edit | edit source]

Anyone can get Developer access. Once you've registered, if you're interested in working on pywikipedia, please email the mailing list and introduce yourself and mention what you'd like to work on, so other people can greet you.

Working with source code[edit | edit source]

#for hacking core
git clone ssh://USERNAME@gerrit.wikimedia.org:29418/pywikibot/core.git

and after modifying the code, follow the steps in Gerrit/Tutorial.

Example (step-by-step)[edit | edit source]

So for example if you want to work with compat (formerly known as trunk), do the following, step-by-step:

  1. setup your software:
    1. if not done already for svn[1] access; create an SSH key, a developer account and add your public key to gerrit as well as to wikitech
    2. install 'git' package
    3. install 'git-review' package (the one by openstack [1], NOT the one by Facebook)
  2. clone and setup your repo:
    1. clone the git[2] repo with all submodules by using (like svn checkout)
      $ git clone --recursive ssh://USERNAME@gerrit.wikimedia.org:29418/pywikibot/compat.git pywikipedia-git
      
      and wait, this step will take some time
    2. enter the directory
      $ cd pywikipedia-git
      
    3. config git setting for this repo/directory only (not global, in case e.g. you have different pseudo for multiple projects)
      $ git config user.email "EMAIL"
      
      and
      $ git config user.name "USERNAME"
      
      in order to configure this globally, use the --global parameter
    4. config your terminal/console to output english messages (in order to work properly with git review, see Gerrit/git-review#Troubleshooting)
      $ alias git="LANG=C git"
      
      this has to be done every time a new console is started, in order to configure this permanently, put this into your bashrc or similar setup file
    5. setup git review for this repo only
      $ git review -s
      
      and enter your USERNAME again, this is an important step - if you forget it, according to Gerrit/Tutorial#Push your change set to Gerrit, the final git review below (needed to commit your changes for review) will fail - though this can be still solved then
  3. work with the repo, e.g. commit patches for review:
    1. switch to the master branch (might not be needed)
      $ git checkout master
      
    2. update the current branch to revision online (like svn update)
      $ git pull
      
    3. create your own local temporary branch for working
      $ git checkout -b MEANINGFUL_BRANCH_NAME
      
      and try to choose a MEANINGFUL_BRANCH_NAME with the help of the branch naming tips available
    4. now write some code; see the Git commands add, rm and mv to add, remove or rename files - when you're ready go to the next step
    5. commit your changes to your local temporary branch with
      $ git commit --all # In the Gerrit world you can do this only once per branch! Remember to follow the commit message guidelines.
      
      (you can use -a instead of --all and -R instead of --no-rebase) and, as used from svn, enter a meaningful commit message, e.g. a short description of your code changes
    6. optionally, check your changes by looking at the committed data
      $ git show HEAD
      
      and make sure that you are sending what you wanted to
    7. send the data to the online repository, resp. gerrit for review (like svn commit)
      $ git review
      
    8. finally go to Gerrit, click on your change and write a reviewer's name in the input box near the "Add Reviewer" button

Documentation[edit | edit source]

This is the user and developer manual, as can be found on Manual:Pywikibot, please help keeping it updated.

The code itself is partly documented as well with help of doxygen. You can find them, e.g. at:

as well as unit test code coverage reports at:

Bot & Proxy[edit | edit source]

Core: Add the following lines to user-config.py:

import httplib2, socks
proxy = httplib2.ProxyInfo(socks.PROXY_TYPE_HTTP, 'localhost', 8080)


Compat: Add the following line to your user-config.py:

proxy = {'host': 'localhost:8080', 'auth': None}

Debugging network issues[edit | edit source]

See Pywikibot/mitmproxy for tips.

See also[edit | edit source]

References[edit | edit source]

  1. Book: Version Control with Subversion for Subversion 1.7. http://svnbook.red-bean.com/
  2. Book: Pro Git. http://git-scm.com/book