A Python robot that edits Wikipedia and interacts with people over IRC https://en.wikipedia.org/wiki/User:EarwigBot
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

installation.rst 2.4 KiB

12 years ago
12 years ago
12 years ago
9 years ago
12 years ago
12 years ago
12 years ago
9 years ago
12 years ago
12 years ago
12 years ago
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  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.2)
  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. If you get an error while pip is installing dependencies, you may be missing
  18. some header files. For example, on Ubuntu, see `this StackOverflow post`_.
  19. You can also install it from source [1]_ directly::
  20. curl -Lo earwigbot.tgz https://github.com/earwig/earwigbot/tarball/v0.2
  21. tar -xf earwigbot.tgz
  22. cd earwig-earwigbot-*
  23. python setup.py install
  24. cd ..
  25. rm -r earwigbot.tgz earwig-earwigbot-*
  26. Development version
  27. -------------------
  28. You can install the development version of the bot from :command:`git` by using
  29. setuptools's :command:`develop` command [1]_, probably on the ``develop``
  30. branch which contains (usually) working code. ``master`` contains the latest
  31. release. EarwigBot uses `git flow`_, so you're free to browse by tags or by new
  32. features (``feature/*`` branches)::
  33. git clone git://github.com/earwig/earwigbot.git earwigbot
  34. cd earwigbot
  35. python setup.py develop
  36. .. rubric:: Footnotes
  37. .. [1] :command:`python setup.py install`/:command:`develop` may require root,
  38. or use the :command:`--user` switch to install for the current user
  39. only.
  40. .. _my instance of EarwigBot: http://en.wikipedia.org/wiki/User:EarwigBot
  41. .. _earwigbot-plugins: https://github.com/earwig/earwigbot-plugins
  42. .. _Python Package Index: http://pypi.python.org
  43. .. _get pip: http://pypi.python.org/pypi/pip
  44. .. _this StackOverflow post: http://stackoverflow.com/questions/6504810/how-to-install-lxml-on-ubuntu/6504860#6504860
  45. .. _git flow: http://nvie.com/posts/a-successful-git-branching-model/