Prepare release 0.19 (#1049)

* Add new samples and delete redundant ones
* Clean up hidden_views by making it an attribute of WorkbookItem
* Add type hints for workbook and data source revisions, data alerts, Favorites, Flows, groups, permissions, projects, flow runs, site,  subscriptions, Users, webhooks 
* add get_by_id method and test for schedules
* Allow null value for user quota tiers
* fix workbook.delete_extract
* add publish to pypi action
 fix xml generation for items
* Add Status, ParentProjectId and StartedAt filters for jobs endpoint
* make project_id nullable to support "Personal Space" for workbooks
* create single Credentials class
* Reassign content on user removal
* add redaction method to remove passwords when logging requests and responses, which can contain embedded credentials.
* remove support for python 3.6 (add python version enforcement in setup.py)
* Extract refreshable item IDs from job XML response 
* Do not eagerly fetch content when a stream was requested
* Fix QuerySet slicing logic
* add CRUD methods for default permissions
* refactor Resource Types and add sample code

Author: jacalata

.github/workflows/run-tests.yml

@@ -8,7 +8,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: ['3.6', '3.7', '3.8', '3.9', '3.10']
+        python-version: ['3.7', '3.8', '3.9', '3.10']
 
     runs-on: ${{ matrix.os }}
 

.gitignore

@@ -78,7 +78,6 @@ target/
 
 # poetry
 poetry.lock
-pyproject.toml
 
 # celery beat schedule file
 celerybeat-schedule

README.md

@@ -8,7 +8,7 @@ Use the Tableau Server Client (TSC) library to increase your productivity as you
 * Create users and groups.
 * Query projects, sites, and more.
 
-This repository contains Python source code for the library and sample files showing how to use it. Python versions 3.6 and up are supported.
+This repository contains Python source code for the library and sample files showing how to use it. As of May 2022, Python versions 3.7 and up are supported.
 
 To see sample code that works directly with the REST API (in Java, Python, or Postman), visit the [REST API Samples](https://github.com/tableau/rest-api-samples) repo.
 

publish.sh

@@ -1,8 +1,11 @@
 #!/usr/bin/env bash
 
+# tag the release version and confirm a clean version number
+git tag vxxxx
+git describe --tag --dirty --always 
+
 set -e
 
 rm -rf dist
-python3 setup.py sdist
-python3 setup.py bdist_wheel
+python setup.py sdist bdist_wheel
 twine upload dist/*

pyproject.toml

@@ -0,0 +1,18 @@
+[build-system]
+requires = ["setuptools>=45.0", "versioneer-518", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.black]
+line-length = 120
+target-version = ['py37', 'py38', 'py39', 'py310']
+
+[tool.mypy]
+disable_error_code = [
+    'misc',
+    'import'
+]
+files = [
+    "tableauserverclient",
+    "test"
+]
+show_error_codes = true

samples/add_default_permission.py

@@ -1,6 +1,6 @@
 ####
 # This script demonstrates how to add default permissions using TSC
-# To run the script, you must have installed Python 3.6 or later.
+# To run the script, you must have installed Python 3.7 or later.
 #
 # In order to demonstrate adding a new default permission, this sample will create
 # a new project and add a new capability to the new project, for the default "All users" group.

samples/create_group.py

@@ -2,7 +2,7 @@
 # This script demonstrates how to create a group using the Tableau
 # Server Client.
 #
-# To run the script, you must have installed Python 3.6 or later.
+# To run the script, you must have installed Python 3.7 or later.
 ####
 
 

samples/create_project.py

@@ -4,7 +4,7 @@
 # parent_id.
 #
 #
-# To run the script, you must have installed Python 3.6 or later.
+# To run the script, you must have installed Python 3.7 or later.
 ####
 
 import argparse
@@ -21,7 +21,8 @@ def create_project(server, project_item, samples=False):
         return project_item
     except TSC.ServerResponseError:
         print("We have already created this project: %s" % project_item.name)
-        sys.exit(1)
+    project_items = server.projects.filter(name=project_item.name)
+    return project_items[0]
 
 
 def main():
@@ -52,7 +53,8 @@ def main():
     logging.basicConfig(level=logging_level)
 
     tableau_auth = TSC.PersonalAccessTokenAuth(args.token_name, args.token_value, site_id=args.site)
-    server = TSC.Server(args.server)
+    server = TSC.Server(args.server, http_options={"verify": False})
+
     server.use_server_version()
     with server.auth.sign_in(tableau_auth):
         # Use highest Server REST API version available
@@ -73,6 +75,21 @@ def main():
         # Projects can be updated
         changed_project = server.projects.update(grand_child_project, samples=True)
 
+        server.projects.populate_workbook_default_permissions(changed_project),
+        server.projects.populate_flow_default_permissions(changed_project),
+        server.projects.populate_lens_default_permissions(changed_project),  # uses same as workbook
+        server.projects.populate_datasource_default_permissions(changed_project),
+        server.projects.populate_permissions(changed_project)
+        # Projects have default permissions set for the object types they contain
+        print("Permissions from project {}:".format(changed_project.id))
+        print(changed_project.permissions)
+        print(
+            changed_project.default_workbook_permissions,
+            changed_project.default_datasource_permissions,
+            changed_project.default_lens_permissions,
+            changed_project.default_flow_permissions,
+        )
+
 
 if __name__ == "__main__":
     main()

samples/create_schedules.py

@@ -2,7 +2,7 @@
 # This script demonstrates how to create schedules using the Tableau
 # Server Client.
 #
-# To run the script, you must have installed Python 3.6 or later.
+# To run the script, you must have installed Python 3.7 or later.
 ####
 
 

samples/download_view_image.py

@@ -2,7 +2,7 @@
 # This script demonstrates how to export a view using the Tableau
 # Server Client.
 #
-# To run the script, you must have installed Python 3.6 or later.
+# To run the script, you must have installed Python 3.7 or later.
 ####
 
 import argparse
@@ -40,10 +40,13 @@ def main():
     group.add_argument(
         "--csv", dest="type", action="store_const", const=("populate_csv", "CSVRequestOptions", "csv", "csv")
     )
+    # other options shown in explore_workbooks: workbook.download, workbook.preview_image
+
+    parser.add_argument("--workbook", action="store_true")
 
     parser.add_argument("--file", "-f", help="filename to store the exported data")
     parser.add_argument("--filter", "-vf", metavar="COLUMN:VALUE", help="View filter to apply to the view")
-    parser.add_argument("resource_id", help="LUID for the view")
+    parser.add_argument("resource_id", help="LUID for the view or workbook")
 
     args = parser.parse_args()
 
@@ -52,34 +55,46 @@ def main():
     logging.basicConfig(level=logging_level)
 
     tableau_auth = TSC.PersonalAccessTokenAuth(args.token_name, args.token_value, site_id=args.site)
-    server = TSC.Server(args.server, use_server_version=True)
+    server = TSC.Server(args.server, use_server_version=True, http_options={"verify": False})
     with server.auth.sign_in(tableau_auth):
-        views = filter(lambda x: x.id == args.resource_id or x.name == args.resource_id, TSC.Pager(server.views.get))
-        view = list(views).pop()  # in python 3 filter() returns a filter object
+        print("Connected")
+        if args.workbook:
+            item = server.workbooks.get_by_id(args.resource_id)
+        else:
+            item = server.views.get_by_id(args.resource_id)
+
+        if not item:
+            print("No item found for id {}".format(args.resource_id))
+            exit(1)
 
+        print("Item found: {}".format(item.name))
         # We have a number of different types and functions for each different export type.
         # We encode that information above in the const=(...) parameter to the add_argument function to make
         # the code automatically adapt for the type of export the user is doing.
         # We unroll that information into methods we can call, or objects we can create by using getattr()
         (populate_func_name, option_factory_name, member_name, extension) = args.type
         populate = getattr(server.views, populate_func_name)
+        if args.workbook:
+            populate = getattr(server.workbooks, populate_func_name)
+
         option_factory = getattr(TSC, option_factory_name)
 
         if args.filter:
             options = option_factory().vf(*args.filter.split(":"))
         else:
             options = None
+
         if args.file:
             filename = args.file
         else:
             filename = "out.{}".format(extension)
 
-        populate(view, options)
+        populate(item, options)
         with open(filename, "wb") as f:
             if member_name == "csv":
-                f.writelines(getattr(view, member_name))
+                f.writelines(getattr(item, member_name))
             else:
-                f.write(getattr(view, member_name))
+                f.write(getattr(item, member_name))
         print("saved to " + filename)