earwigbot/docs/index.rst

EarwigBot v0.4.1 Documentation
==============================

EarwigBot_ is a Python bot that edits Wikipedia_ and interacts over IRC_.

History
-------

Development began, based on `Pywikibot`_, in early 2009. Approval for its
first task, a `copyright violation detector`_, was carried out in May, and the
bot has been running consistently ever since. It currently handles
`several ongoing tasks`_ ranging from statistics generation to category
cleanup, and on-demand tasks such as WikiProject template tagging. Since it
started running, the bot has made over 300,000 edits.

The current version of its codebase began development in April 2011, moving
away from Pywikibot to a custom framework.

.. _EarwigBot:                      https://en.wikipedia.org/wiki/User:EarwigBot
.. _Wikipedia:                      https://en.wikipedia.org/
.. _IRC:                            https://en.wikipedia.org/wiki/Internet_Relay_Chat
.. _PyPI:                           https://packages.python.org/earwigbot
.. _Pywikibot:                      https://www.mediawiki.org/wiki/Manual:Pywikibot
.. _copyright violation detector:   https://en.wikipedia.org/wiki/Wikipedia:Bots/Requests_for_approval/EarwigBot_1
.. _several ongoing tasks:          https://en.wikipedia.org/wiki/User:EarwigBot#Tasks

Contents
--------

.. toctree::
   :maxdepth: 2

   installation
   setup
   customizing
   toolset
   tips
   API Reference <api/modules>

Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`