This package contains the core earwigbot, abstracted enough that it should be usable and customizable by anyone running a bot on a MediaWiki site. Since it is component-based, the IRC components can be disabled if desired. IRC commands and bot tasks specific to my instance of EarwigBot that I don’t feel the average user will need are available from the repository earwigbot-plugins.
It’s recommended to run the bot’s unit tests before installing. Run python setup.py test from the project’s root directory. Note that some tests require an internet connection, and others may take a while to run. Coverage is currently rather incomplete.
EarwigBot is available from the Python Package Index, so you can install the latest release with pip install earwigbot (get pip).
If you get an error while pip is installing dependencies, you may be missing some header files. For example, on Ubuntu, see this StackOverflow post.
You can also install it from source [1] directly:
curl -Lo earwigbot.tgz https://github.com/earwig/earwigbot/tarball/v0.2
tar -xf earwigbot.tgz
cd earwig-earwigbot-*
python setup.py install
cd ..
rm -r earwigbot.tgz earwig-earwigbot-*
You can install the development version of the bot from git by using setuptools’s develop command [1], probably on the develop branch which contains (usually) working code. master contains the latest release. EarwigBot uses git flow, so you’re free to browse by tags or by new features (feature/* branches):
git clone git://github.com/earwig/earwigbot.git earwigbot
cd earwigbot
python setup.py develop
Footnotes
| [1] | (1, 2) python setup.py install/develop may require root, or use the –user switch to install for the current user only. |