hooke/plugin/license.py

   1 # Copyright (C) 2010 W. Trevor King <wking@drexel.edu>
   2 #
   3 # This file is part of Hooke.
   4 #
   5 # Hooke is free software: you can redistribute it and/or modify it
   6 # under the terms of the GNU Lesser General Public License as
   7 # published by the Free Software Foundation, either version 3 of the
   8 # License, or (at your option) any later version.
   9 #
  10 # Hooke is distributed in the hope that it will be useful, but WITHOUT
  11 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  12 # or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General
  13 # Public License for more details.
  14 #
  15 # You should have received a copy of the GNU Lesser General Public
  16 # License along with Hooke.  If not, see
  17 # <http://www.gnu.org/licenses/>.
  18
  19 """The ``license`` module provides :class:`LicensePlugin` and
  20 associated :class:`hooke.command.Command`\s for displaying Hooke's
  21 licensing information.
  22 """
  23
  24 from .. import __license__
  25 from ..command import Command, Argument, Failure
  26 from ..plugin import Builtin
  27
  28
  29 class LicensePlugin (Builtin):
  30     def __init__(self):
  31         super(LicensePlugin, self).__init__(name='license')
  32         self._commands = [LicenseCommand(self)]
  33
  34
  35 # Define commands
  36
  37 class LicenseCommand (Command):
  38     """Show licensing information.
  39     """
  40     def __init__(self, plugin):
  41         super(LicenseCommand, self).__init__(
  42             name='license',
  43             help=self.__doc__, plugin=plugin)
  44
  45     def _run(self, hooke, inqueue, outqueue, params):
  46         outqueue.put(__license__)