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

56 lines
2.0 KiB
Raw Blame History 

  1. Installation

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

  3. 

  4. This package contains the core :py:mod:`earwigbot`, abstracted to be usable

  5. and customizable by anyone running a bot on a MediaWiki site. Since it is

  6. modular, the IRC components can be disabled if desired. IRC commands and bot

  7. tasks specific to `my instance of EarwigBot`_ that I don't feel the average

  8. user will need are available from the repository `earwigbot-plugins`_.

  9. 

  10. Latest release

  11. --------------

  12. 

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

  14. the latest release with:

  15. 

  16.     pip install earwigbot

  17. 

  18. There are a few sets of optional dependencies:

  19. 

  20. - ``crypto``: Allows encrypting bot passwords and secrets in the config

  21. - ``sql``: Allows interfacing with MediaWiki databases (e.g. on Toolforge_)

  22. - ``copyvios``: Includes parsing libraries for checking copyright violations

  23. - ``dev``: Installs development dependencies (e.g. test runners)

  24. 

  25. For example, to install all non-dev dependencies:

  26. 

  27.     pip install 'earwigbot[crypto,sql,copyvios]'

  28. 

  29. Errors while pip is installing dependencies may be due to missing header

  30. files. For example, on Ubuntu, see `this StackOverflow post`_.

  31. 

  32. Development version

  33. -------------------

  34. 

  35. You can install the development version of the bot::

  36. 

  37.     git clone https://github.com/earwig/earwigbot.git

  38.     cd earwigbot

  39.     python3 -m venv venv

  40.     . venv/bin/activate

  41.     pip install -e '.[crypto,sql,copyvios,dev]'

  42. 

  43. Or with `uv`_::

  44. 

  45.     uv sync --all-extras

  46. 

  47. To run the bot's unit tests, run :command:`pytest` (requires the ``dev``

  48. dependencies). Coverage is currently rather incomplete.

  49. 

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

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

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

  53. .. _Toolforge:                https://wikitech.wikimedia.org/wiki/Portal:Toolforge

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

  55. .. _uv:                       https://docs.astral.sh/uv/