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 1.6 KiB

12 years ago
12 years ago
12 years ago
12 years ago
12 years ago
12 years ago
12 years ago
1234567891011121314151617181920212223242526272829303132333435363738
  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
  14. --------------
  15. EarwigBot is available from the `Python Package Index`_, so you can install the
  16. latest release with :command:`pip install earwigbot`.
  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. Development version
  20. -------------------
  21. You can install the development version of the bot from :command:`git` by using
  22. setuptools's :command:`develop` command::
  23. git clone git://github.com/earwig/earwigbot.git earwigbot
  24. cd earwigbot
  25. python setup.py develop
  26. .. _my instance of EarwigBot: https://en.wikipedia.org/wiki/User:EarwigBot
  27. .. _earwigbot-plugins: https://github.com/earwig/earwigbot-plugins
  28. .. _Python Package Index: https://pypi.python.org/pypi/earwigbot
  29. .. _this StackOverflow post: https://stackoverflow.com/questions/6504810/how-to-install-lxml-on-ubuntu/6504860#6504860