Merge pull request gpiozero#604 from RPi-Distro/pinout-xyz

bennuttall · web-flow · commit 27d409702f27 · 2018-03-24T17:20:54.000Z
Add --xyz option to pinout cli tool
diff --git a/docs/cli_pinout.rst b/docs/cli_pinout.rst
@@ -8,7 +8,7 @@ Synopsis
 
 ::
 
-    pinout [-h] [-r REVISION] [-c] [-m]
+    pinout [-h] [-r REVISION] [-c] [-m] [-x]
 
 Description
 -----------
@@ -41,6 +41,10 @@ Options
 
     Force monochrome output. See also :option:`--color`
 
+.. option:: -x, --xyz
+
+    Open `pinout.xyz`_ in the default web browser
+
 Examples
 --------
 
@@ -172,4 +176,5 @@ PIGPIO_PORT
 
         :manpage:`remote-gpio(7)`
 
-.. _revision codes: http://elinux.org/RPi_HardwareHistory
+.. _pinout.xyz: https://pinout.xyz/
+.. _revision codes: https://www.raspberrypi.org/documentation/hardware/raspberrypi/revision-codes/README.md
diff --git a/gpiozerocli/pinout.py b/gpiozerocli/pinout.py
@@ -13,6 +13,7 @@
 import sys
 import textwrap
 import warnings
+import webbrowser
 
 class PinoutTool(object):
     def __init__(self):
@@ -38,6 +39,12 @@ def __init__(self):
             action='store_false',
             help='Force monochrome output. See also --color'
         )
+        self.parser.add_argument(
+            '-x', '--xyz',
+            dest='xyz',
+            action='store_true',
+            help='Open pinout.xyz in the default web browser'
+        )
 
     def __call__(self, args=None):
         if args is None:
@@ -69,23 +76,27 @@ def main(self, args):
                 "remotely access your Pi."
             )
             formatter.add_text(
-                "* https://gpiozero.readthedocs.io/en/latest/remote_gpio.html"
+                "* https://gpiozero.readthedocs.io/en/stable/remote_gpio.html"
             )
             sys.stderr.write(formatter.format_help())
         else:
-            if args.revision == '':
-                try:
-                    pi_info().pprint(color=args.color)
-                except IOError:
-                    raise IOError('This device is not a Raspberry Pi')
+            if args.xyz:
+                webbrowser.open('https://pinout.xyz')
             else:
-                pi_info(args.revision).pprint(color=args.color)
-            formatter = self.parser._get_formatter()
-            formatter.add_text(
-                "For further information, please refer to https://pinout.xyz/"
-            )
-            sys.stdout.write('\n')
-            sys.stdout.write(formatter.format_help())
+                if args.revision == '':
+                    try:
+                        pi_info().pprint(color=args.color)
+                    except IOError:
+                        raise IOError('This device is not a Raspberry Pi')
+                else:
+                    pi_info(args.revision).pprint(color=args.color)
+                formatter = self.parser._get_formatter()
+                formatter.add_text(
+                    "For further information, please refer to "
+                    "https://pinout.xyz/"
+                )
+                sys.stdout.write('\n')
+                sys.stdout.write(formatter.format_help())
 
 
 main = PinoutTool()
