samples/move_workbook_sites.py

####
# This script demonstrates how to use the Tableau Server API
# to move a workbook from one site to another. It will find
# a workbook that matches a given name, download the workbook,
# and then publish it to the destination site.
#
# To run the script, you must have installed Python 2.7.9 or later.
####

import tableauserverclient as TSC
import shutil
import argparse
import tempfile
import getpass
import logging

parser = argparse.ArgumentParser(description="Move one workbook from the"
                                             "default project of the default site to"
                                             "the default project of another site.")
parser.add_argument('--server', '-s', required=True, help='server address')
parser.add_argument('--username', '-u', required=True, help='username to sign into server')
parser.add_argument('--workbook-name', '-w', required=True, help='name of workbook to move')
parser.add_argument('--destination-site', '-d', required=True, help='name of site to move workbook into')
parser.add_argument('--logging-level', '-l', choices=['debug', 'info', 'error'], default='error',
                    help='desired logging level (set to error by default)')
args = parser.parse_args()

password = getpass.getpass("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)

# Step 1: Sign in to both sites on server
tableau_auth = TSC.TableauAuth(args.username, password)

source_server = TSC.Server(args.server)
dest_server = TSC.Server(args.server)

with source_server.auth.sign_in(tableau_auth):
    # Step 2: Query workbook to move
    req_option = TSC.RequestOptions()
    req_option.filter.add(TSC.Filter(TSC.RequestOptions.Field.Name,
                                     TSC.RequestOptions.Operator.Equals, args.workbook_name))
    all_workbooks, pagination_item = source_server.workbooks.get(req_option)

    # Step 3: Download workbook to a temp directory
    if len(all_workbooks) == 0:
        print('No workbook named {} found.'.format(args.workbook_name))
    else:
        tmpdir = tempfile.mkdtemp()
        try:
            workbook_path = source_server.workbooks.download(all_workbooks[0].id, tmpdir)

            # Step 4: Check if destination site exists, then sign in to the site
            pagination_info, all_sites = source_server.sites.get()
            found_destination_site = any((True for site in all_sites if
                                          args.destination_site.lower() == site.content_url.lower()))
            if not found_destination_site:
                error = "No site named {} found.".format(args.destination_site)
                raise LookupError(error)

            tableau_auth.site = args.destination_site

            # Signing into another site requires another server object
            # because of the different auth token and site ID.
            with dest_server.auth.sign_in(tableau_auth):

                # Step 5: Find destination site's default project
                pagination_info, dest_projects = dest_server.projects.get()
                target_project = next((project for project in dest_projects if project.is_default()), None)

                # Step 6: If default project is found, form a new workbook item and publish.
                if target_project is not None:
                    new_workbook = TSC.WorkbookItem(name=args.workbook_name, project_id=target_project.id)
                    new_workbook = dest_server.workbooks.publish(new_workbook, workbook_path,
                                                                 mode=dest_server.PublishMode.Overwrite)
                    print("Successfully moved {0} ({1})".format(new_workbook.name, new_workbook.id))
                else:
                    error = "The default project could not be found."
                    raise LookupError(error)

            # Step 7: Delete workbook from source site and delete temp directory
            source_server.workbooks.delete(all_workbooks[0].id)
        finally:
            shutil.rmtree(tmpdir)