add export_wb sample for 'fullpdf' (tableau#264)

Russell Hay · web-flow · commit 86e463810be8 · 2018-02-21T11:58:16.000-08:00
* add export_wb sample for 'fullpdf'

* Addressing code review feedback from Lee

* Fixing the dumb thing that I did where I was getting the view, then throwing it away and getting it again...

* pep8 error
diff --git a/samples/export_wb.py b/samples/export_wb.py
@@ -0,0 +1,92 @@
+#
+# This sample uses the PyPDF2 library for combining pdfs together to get the full pdf for all the views in a
+# workbook.
+#
+# You will need to do `pip install PyPDF2` to use this sample.
+#
+
+import argparse
+import getpass
+import logging
+import tempfile
+import shutil
+import functools
+import os.path
+
+import tableauserverclient as TSC
+try:
+    import PyPDF2
+except ImportError:
+    print('Please `pip install PyPDF2` to use this sample')
+    import sys
+    sys.exit(1)
+
+
+def get_views_for_workbook(server, workbook_id):  # -> Iterable of views
+    workbook = server.workbooks.get_by_id(workbook_id)
+    server.workbooks.populate_views(workbook)
+    return workbook.views
+
+
+def download_pdf(server, tempdir, view):  # -> Filename to downloaded pdf
+    logging.info("Exporting {}".format(view.id))
+    destination_filename = os.path.join(tempdir, view.id)
+    server.views.populate_pdf(view)
+    with file(destination_filename, 'wb') as f:
+        f.write(view.pdf)
+
+    return destination_filename
+
+
+def combine_into(dest_pdf, filename):  # -> None
+    dest_pdf.append(filename)
+    return dest_pdf
+
+
+def cleanup(tempdir):
+    shutil.rmtree(tempdir)
+
+
+def main():
+    parser = argparse.ArgumentParser(description='Export to PDF all of the views in a workbook')
+    parser.add_argument('--server', '-s', required=True, help='server address')
+    parser.add_argument('--site', '-S', default=None, help='Site to log into, do not specify for default site')
+    parser.add_argument('--username', '-u', required=True, help='username to sign into server')
+    parser.add_argument('--password', '-p', default=None, help='password for the user')
+
+    parser.add_argument('--logging-level', '-l', choices=['debug', 'info', 'error'], default='error',
+                        help='desired logging level (set to error by default)')
+    parser.add_argument('--file', '-f', default='out.pdf', help='filename to store the exported data')
+    parser.add_argument('resource_id', help='LUID for the workbook')
+
+    args = parser.parse_args()
+
+    if args.password is None:
+        password = getpass.getpass("Password: ")
+    else:
+        password = args.password
+
+    # Set logging level based on user input, or error by default
+    logging_level = getattr(logging, args.logging_level.upper())
+    logging.basicConfig(level=logging_level)
+
+    tempdir = tempfile.mkdtemp('tsc')
+    logging.debug("Saving to tempdir: %s", tempdir)
+
+    tableau_auth = TSC.TableauAuth(args.username, password, args.site)
+    server = TSC.Server(args.server, use_server_version=True)
+    try:
+        with server.auth.sign_in(tableau_auth):
+            get_list = functools.partial(get_views_for_workbook, server)
+            download = functools.partial(download_pdf, server, tempdir)
+
+            downloaded = (download(x) for x in get_list(args.resource_id))
+            output = reduce(combine_into, downloaded, PyPDF2.PdfFileMerger())
+            with file(args.file, 'wb') as f:
+                output.write(f)
+    finally:
+        cleanup(tempdir)
+
+
+if __name__ == '__main__':
+    main()
diff --git a/samples/list.py b/samples/list.py
@@ -14,9 +14,9 @@
 def main():
     parser = argparse.ArgumentParser(description='List out the names and LUIDs for different resource types')
     parser.add_argument('--server', '-s', required=True, help='server address')
+    parser.add_argument('--site', '-S', default=None, help='site to log into, do not specify for default site')
     parser.add_argument('--username', '-u', required=True, help='username to sign into server')
-    parser.add_argument('--site', '-S', default=None)
-    parser.add_argument('-p', default=None)
+    parser.add_argument('--password', '-p', default=None, help='password for the user')
 
     parser.add_argument('--logging-level', '-l', choices=['debug', 'info', 'error'], default='error',
                         help='desired logging level (set to error by default)')
@@ -25,10 +25,10 @@ def main():
 
     args = parser.parse_args()
 
-    if args.p is None:
+    if args.password is None:
         password = getpass.getpass("Password: ")
     else:
-        password = args.p
+        password = args.password
 
     # Set logging level based on user input, or error by default
     logging_level = getattr(logging, args.logging_level.upper())
