A Python robot that edits Wikipedia and interacts with people over IRC https://en.wikipedia.org/wiki/User:EarwigBot

52 linhas
2.4 KiB

  1. # -*- coding: utf-8 -*-
  2. #
  3. # Copyright (C) 2009-2014 Ben Kurtovic <ben.kurtovic@gmail.com>
  4. #
  5. # Permission is hereby granted, free of charge, to any person obtaining a copy
  6. # of this software and associated documentation files (the "Software"), to deal
  7. # in the Software without restriction, including without limitation the rights
  8. # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  9. # copies of the Software, and to permit persons to whom the Software is
  10. # furnished to do so, subject to the following conditions:
  11. #
  12. # The above copyright notice and this permission notice shall be included in
  13. # all copies or substantial portions of the Software.
  14. #
  15. # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16. # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17. # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18. # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19. # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20. # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  21. # SOFTWARE.
  22. """
  23. **EarwigBot: Wiki Toolset**
  24. This is a collection of classes and functions to read from and write to
  25. Wikipedia and other wiki sites. No connection whatsoever to `python-wikitools
  26. <http://code.google.com/p/python-wikitools/>`_ written by `Mr.Z-man
  27. <http://en.wikipedia.org/wiki/User:Mr.Z-man>`_, other than a similar purpose.
  28. We share no code.
  29. Import the toolset directly with ``from earwigbot import wiki``. If using the
  30. built-in integration with the rest of the bot, :py:class:`~earwigbot.bot.Bot`
  31. objects contain a :py:attr:`~earwigbot.bot.Bot.wiki` attribute, which is a
  32. :py:class:`~earwigbot.wiki.sitesdb.SitesDB` object tied to the :file:`sites.db`
  33. file located in the same directory as :file:`config.yml`. That object has the
  34. principal methods :py:meth:`~earwigbot.wiki.sitesdb.SitesDB.get_site`,
  35. :py:meth:`~earwigbot.wiki.sitesdb.SitesDB.add_site`, and
  36. :py:meth:`~earwigbot.wiki.sitesdb.SitesDB.remove_site` that should handle all
  37. of your :py:class:`~earwigbot.wiki.site.Site` (and thus,
  38. :py:class:`~earwigbot.wiki.page.Page`,
  39. :py:class:`~earwigbot.wiki.category.Category`, and
  40. :py:class:`~earwigbot.wiki.user.User`) needs.
  41. """
  42. from earwigbot.wiki.category import *
  43. from earwigbot.wiki.constants import *
  44. from earwigbot.wiki.page import *
  45. from earwigbot.wiki.site import *
  46. from earwigbot.wiki.sitesdb import *
  47. from earwigbot.wiki.user import *