ben
/
earwigbot
spegling av https://github.com/earwig/earwigbot
1
1
Förgrening 0
Kod Släpp 4 Aktiviteter
A Python robot that edits Wikipedia and interacts with people over IRC https://en.wikipedia.org/wiki/User:EarwigBot
Du kan inte välja fler än 25 ämnen Ämnen måste starta med en bokstav eller siffra, kan innehålla bindestreck ('-') och vara max 35 tecken långa.
389 Incheckningar
2 Grenar
21 MiB
 
Träd: 035f7b80fc
Grenar Taggar
${ item.name }
Skapa branchen ${ searchTerm }
från '035f7b80fc'
${ noResults }
earwigbot/docs/installation.rst

54 rader
2.1 KiB
Rå Blame Historik 

  1. Installation

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

  3. 

  4. This package contains the core ``earwigbot``, abstracted enough that it should

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

  6. 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 ``python

  12. setup.py test`` from the project's root directory. Note that some

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

  14. Coverage is currently rather incomplete.

  15. 

  16. Latest release (v0.1)

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

  18. 

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

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

  21. 

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

  23. 

  24.     curl -Lo earwigbot.tgz https://github.com/earwig/earwigbot/tarball/v0.1

  25.     tar -xf earwigbot.tgz

  26.     cd earwig-earwigbot-*

  27.     python setup.py install

  28.     cd ..

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

  30. 

  31. Development version

  32. -------------------

  33. 

  34. You can install the development version of the bot from ``git`` by using

  35. setuptools/distribute's ``develop`` command [1]_, probably on the ``develop``

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

  37. release. EarwigBot uses `git flow`_, so you're free to

  38. browse by tags or by new features (``feature/*`` branches)::

  39. 

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

  41.     cd earwigbot

  42.     python setup.py develop

  43. 

  44. .. rubric:: Footnotes

  45. 

  46. .. [1] ``python setup.py install``/``develop`` may require root, or use the

  47.        ``--user`` switch to install for the current user only.

  48. 

  49. .. _my instance of EarwigBot:       http://en.wikipedia.org/wiki/User:EarwigBot

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

  51. .. _Python Package Index:           http://pypi.python.org

  52. .. _get pip:                        http://pypi.python.org/pypi/pip

  53. .. _git flow:                       http://nvie.com/posts/a-successful-git-branching-model/