A Python robot that edits Wikipedia and interacts with people over IRC https://en.wikipedia.org/wiki/User:EarwigBot

56 lines
2.2 KiB

  1. Installation
  2. ============
  3. This package contains the core :py:mod:`earwigbot`, abstracted enough that it
  4. should be usable and customizable by anyone running a bot on a MediaWiki site.
  5. Since it is component-based, the IRC components can be disabled if desired. IRC
  6. commands and bot tasks specific to `my instance of EarwigBot`_ that I don't
  7. feel the average user will need are available from the repository
  8. `earwigbot-plugins`_.
  9. It's recommended to run the bot's unit tests before installing. Run
  10. :command:`python setup.py test` from the project's root directory. Note that
  11. some tests require an internet connection, and others may take a while to run.
  12. Coverage is currently rather incomplete.
  13. Latest release (v0.1)
  14. ---------------------
  15. EarwigBot is available from the `Python Package Index`_, so you can install the
  16. latest release with :command:`pip install earwigbot` (`get pip`_).
  17. You can also install it from source [1]_ directly::
  18. curl -Lo earwigbot.tgz https://github.com/earwig/earwigbot/tarball/v0.1
  19. tar -xf earwigbot.tgz
  20. cd earwig-earwigbot-*
  21. python setup.py install
  22. cd ..
  23. rm -r earwigbot.tgz earwig-earwigbot-*
  24. Development version
  25. -------------------
  26. You can install the development version of the bot from :command:`git` by using
  27. setuptools/`distribute`_'s :command:`develop` command [1]_, probably on the
  28. ``develop`` branch which contains (usually) working code. ``master`` contains
  29. the latest release. EarwigBot uses `git flow`_, so you're free to browse by
  30. tags or by new features (``feature/*`` branches)::
  31. git clone git://github.com/earwig/earwigbot.git earwigbot
  32. cd earwigbot
  33. python setup.py develop
  34. .. rubric:: Footnotes
  35. .. [1] :command:`python setup.py install`/:command:`develop` may require root,
  36. or use the :command:`--user` switch to install for the current user
  37. only.
  38. .. _my instance of EarwigBot: http://en.wikipedia.org/wiki/User:EarwigBot
  39. .. _earwigbot-plugins: https://github.com/earwig/earwigbot-plugins
  40. .. _Python Package Index: http://pypi.python.org
  41. .. _get pip: http://pypi.python.org/pypi/pip
  42. .. _distribute: http://pypi.python.org/pypi/distribute
  43. .. _git flow: http://nvie.com/posts/a-successful-git-branching-model/