ben
/
earwigbot
mirror of https://github.com/earwig/earwigbot
1
1
Fork 0
Code Releases 4 Activity
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.
1146 Commits
2 Branches
39 MiB
 
Tree: 9ee44932f6
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '9ee44932f6'
${ noResults }
earwigbot/docs/installation.rst

59 lines
2.4 KiB
Raw Blame History 

  1. Installation

  2. ============

  3. 

  4. This package contains the core :py:mod:`earwigbot`, abstracted enough that it

  5. should be usable and customizable by anyone running a bot on a MediaWiki site.

  6. Since it is component-based, the IRC components can be disabled if desired. IRC

  7. commands and bot tasks specific to `my instance of EarwigBot`_ that I don't

  8. feel the average user will need are available from the repository

  9. `earwigbot-plugins`_.

  10. 

  11. It's recommended to run the bot's unit tests before installing. Run

  12. :command:`python setup.py test` from the project's root directory. Note that

  13. some tests require an internet connection, and others may take a while to run.

  14. Coverage is currently rather incomplete.

  15. 

  16. Latest release (v0.3)

  17. ---------------------

  18. 

  19. EarwigBot is available from the `Python Package Index`_, so you can install the

  20. latest release with :command:`pip install earwigbot` (`get pip`_).

  21. 

  22. If you get an error while pip is installing dependencies, you may be missing

  23. some header files. For example, on Ubuntu, see `this StackOverflow post`_.

  24. 

  25. You can also install it from source [1]_ directly::

  26. 

  27.     curl -Lo earwigbot.tgz https://github.com/earwig/earwigbot/tarball/v0.3

  28.     tar -xf earwigbot.tgz

  29.     cd earwig-earwigbot-*

  30.     python setup.py install

  31.     cd ..

  32.     rm -r earwigbot.tgz earwig-earwigbot-*

  33. 

  34. Development version

  35. -------------------

  36. 

  37. You can install the development version of the bot from :command:`git` by using

  38. setuptools's :command:`develop` command [1]_, probably on the ``develop``

  39. branch which contains (usually) working code. ``master`` contains the latest

  40. release. EarwigBot uses `git flow`_, so you're free to browse by tags or by new

  41. features (``feature/*`` branches)::

  42. 

  43.     git clone git://github.com/earwig/earwigbot.git earwigbot

  44.     cd earwigbot

  45.     python setup.py develop

  46. 

  47. .. rubric:: Footnotes

  48. 

  49. .. [1] :command:`python setup.py install`/:command:`develop` may require root,

  50.        or use the :command:`--user` switch to install for the current user

  51.        only.

  52. 

  53. .. _my instance of EarwigBot: https://en.wikipedia.org/wiki/User:EarwigBot

  54. .. _earwigbot-plugins:        https://github.com/earwig/earwigbot-plugins

  55. .. _Python Package Index:     https://pypi.python.org/pypi/earwigbot

  56. .. _get pip:                  https://pypi.python.org/pypi/pip

  57. .. _this StackOverflow post:  https://stackoverflow.com/questions/6504810/how-to-install-lxml-on-ubuntu/6504860#6504860

  58. .. _git flow:                 https://nvie.com/posts/a-successful-git-branching-model/