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.
991 Commits
2 Branches
6.0 MiB
 
Tree: 09319b1675
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '09319b1675'
${ noResults }
earwigbot/earwigbot/wiki/__init__.py

52 lines
2.4 KiB
Raw Blame History 

  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. """

  24. **EarwigBot: Wiki Toolset**

  25. 

  26. This is a collection of classes and functions to read from and write to

  27. Wikipedia and other wiki sites. No connection whatsoever to `python-wikitools

  28. <http://code.google.com/p/python-wikitools/>`_ written by `Mr.Z-man

  29. <http://en.wikipedia.org/wiki/User:Mr.Z-man>`_, other than a similar purpose.

  30. We share no code.

  31. 

  32. Import the toolset directly with ``from earwigbot import wiki``. If using the

  33. built-in integration with the rest of the bot, :py:class:`~earwigbot.bot.Bot`

  34. objects contain a :py:attr:`~earwigbot.bot.Bot.wiki` attribute, which is a

  35. :py:class:`~earwigbot.wiki.sitesdb.SitesDB` object tied to the :file:`sites.db`

  36. file located in the same directory as :file:`config.yml`. That object has the

  37. principal methods :py:meth:`~earwigbot.wiki.sitesdb.SitesDB.get_site`,

  38. :py:meth:`~earwigbot.wiki.sitesdb.SitesDB.add_site`, and

  39. :py:meth:`~earwigbot.wiki.sitesdb.SitesDB.remove_site` that should handle all

  40. of your :py:class:`~earwigbot.wiki.site.Site` (and thus,

  41. :py:class:`~earwigbot.wiki.page.Page`,

  42. :py:class:`~earwigbot.wiki.category.Category`, and

  43. :py:class:`~earwigbot.wiki.user.User`) needs.

  44. """

  45. 

  46. from earwigbot.wiki.category import *

  47. from earwigbot.wiki.constants import *

  48. from earwigbot.wiki.page import *

  49. from earwigbot.wiki.site import *

  50. from earwigbot.wiki.sitesdb import *

  51. from earwigbot.wiki.user import *