summaryrefslogtreecommitdiff
path: root/xnt/commands/help.py
blob: e72b13eaf05b2771fedf0715b1088742eb1aba57 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
#!/usr/bin/env python
"""Xnt Help Command"""

#   Xnt -- A Wrapper Build Tool
#   Copyright (C) 2012  Kenny Ballou

#   This program is free software: you can redistribute it and/or modify
#   it under the terms of the GNU General Public License as published by
#   the Free Software Foundation, either version 3 of the License, or
#   (at your option) any later version.

#   This program is distributed in the hope that it will be useful,
#   but WITHOUT ANY WARRANTY; without even the implied warranty of
#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#   GNU General Public License for more details.

#   You should have received a copy of the GNU General Public License
#   along with this program.  If not, see <http://www.gnu.org/licenses/>.

from xnt.basecommand import Command
from xnt.status_codes import SUCCESS

class HelpCommand(Command): #pylint: disable-msg=R0903
    """Help Command"""
    name = 'help'
    usage = """"""
    summary = 'Print Usage Summary'
    needs_build = False

    def run(self, arguments=None):
        """Invoke Help"""
        from xnt.commands import get_summaries
        from xnt import __version__, __license__
        commands = get_summaries()
        print(__version__)
        print(__license__)
        print("Available Commands:")
        for name, summary in commands:
            print(name)
            print("\t" + summary)

        return SUCCESS