tableauserverclient 0.25__tar.gz → 0.27.post0.dev1__tar.gz

{tableauserverclient-0.25 → tableauserverclient-0.27.post0.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tableauserverclient
-Version: 0.25
+Version: 0.27.post0.dev1
 Summary: A Python module for working with the Tableau Server REST API.
 Author-email: Tableau <github@tableau.com>
 License: The MIT License (MIT)
@@ -28,15 +28,28 @@ License: The MIT License (MIT)
 Project-URL: repository, https://github.com/tableau/server-client-python
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
-Provides-Extra: test
 License-File: LICENSE
 License-File: LICENSE.versioneer
+Requires-Dist: defusedxml>=0.7.1
+Requires-Dist: packaging>=23.1
+Requires-Dist: requests>=2.31
+Requires-Dist: urllib3==2.0.6
+Provides-Extra: test
+Requires-Dist: argparse; extra == "test"
+Requires-Dist: black==23.7; extra == "test"
+Requires-Dist: mock; extra == "test"
+Requires-Dist: mypy==1.4; extra == "test"
+Requires-Dist: pytest>=7.0; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: pytest-subtests; extra == "test"
+Requires-Dist: requests-mock<2.0,>=1.0; extra == "test"
 
 # Tableau Server Client (Python)
 

{tableauserverclient-0.25 → tableauserverclient-0.27.post0.dev1}/README.md

@@ -19,4 +19,4 @@ For more information on installing and using TSC, see the documentation:
 
 
 ## License
-[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Ftableau%2Fserver-client-python.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Ftableau%2Fserver-client-python?ref=badge_large)
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Ftableau%2Fserver-client-python.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Ftableau%2Fserver-client-python?ref=badge_large)

tableauserverclient-0.27.post0.dev1/pyproject.toml

@@ -0,0 +1,53 @@
+[build-system]
+requires = ["setuptools>=68.0", "versioneer>=0.29", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name="tableauserverclient"
+
+dynamic = ["version"]
+description='A Python module for working with the Tableau Server REST API.'
+authors = [{name="Tableau", email="github@tableau.com"}]
+license = {file = "LICENSE"}
+readme = "README.md"
+
+dependencies = [
+    'defusedxml>=0.7.1',  # latest as at 7/31/23
+    'packaging>=23.1',   # latest as at 7/31/23
+    'requests>=2.31',  # latest as at 7/31/23
+    'urllib3==2.0.6',  # latest as at 7/31/23
+]
+requires-python = ">=3.7"
+classifiers = [
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.8",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12"
+]
+[project.urls]
+repository = "https://github.com/tableau/server-client-python"
+
+[project.optional-dependencies]
+test = ["argparse", "black==23.7", "mock", "mypy==1.4", "pytest>=7.0", "pytest-cov", "pytest-subtests",
+    "requests-mock>=1.0,<2.0"]
+
+[tool.black]
+line-length = 120
+target-version = ['py37', 'py38', 'py39', 'py310', 'py311', 'py312']
+
+[tool.mypy]
+check_untyped_defs = false
+disable_error_code = [
+    'misc',
+    # tableauserverclient\server\endpoint\datasources_endpoint.py:48: error: Cannot assign multiple types to name "FilePath" without an explicit "Type[...]" annotation  [misc]
+    'annotation-unchecked'  # can be removed when check_untyped_defs = true
+]
+files = ["tableauserverclient", "test"]
+show_error_codes = true
+ignore_missing_imports = true  # defusedxml library has no types
+[tool.pytest.ini_options]
+testpaths = ["test"]
+addopts = "--junitxml=./test.junit.xml"

{tableauserverclient-0.25 → tableauserverclient-0.27.post0.dev1}/samples/add_default_permission.py

@@ -18,14 +18,10 @@ import tableauserverclient as TSC
 def main():
     parser = argparse.ArgumentParser(description="Add workbook default permissions for a given project.")
     # Common options; please keep those in sync across all samples
-    parser.add_argument("--server", "-s", required=True, help="server address")
+    parser.add_argument("--server", "-s", help="server address")
     parser.add_argument("--site", "-S", help="site name")
-    parser.add_argument(
-        "--token-name", "-p", required=True, help="name of the personal access token used to sign into the server"
-    )
-    parser.add_argument(
-        "--token-value", "-v", required=True, help="value of the personal access token used to sign into the server"
-    )
+    parser.add_argument("--token-name", "-p", help="name of the personal access token used to sign into the server")
+    parser.add_argument("--token-value", "-v", help="value of the personal access token used to sign into the server")
     parser.add_argument(
         "--logging-level",
         "-l",

tableauserverclient-0.27.post0.dev1/samples/create_extract_task.py

@@ -0,0 +1,84 @@
+####
+# This script demonstrates how to create extract tasks in Tableau Cloud
+# using the Tableau Server Client.
+#
+# To run the script, you must have installed Python 3.7 or later.
+####
+
+
+import argparse
+import logging
+
+from datetime import time
+
+import tableauserverclient as TSC
+
+
+def main():
+    parser = argparse.ArgumentParser(description="Creates sample extract refresh task.")
+    # Common options; please keep those in sync across all samples
+    parser.add_argument("--server", "-s", help="server address")
+    parser.add_argument("--site", "-S", help="site name")
+    parser.add_argument("--token-name", "-p", help="name of the personal access token used to sign into the server")
+    parser.add_argument("--token-value", "-v", help="value of the personal access token used to sign into the server")
+    parser.add_argument(
+        "--logging-level",
+        "-l",
+        choices=["debug", "info", "error"],
+        default="error",
+        help="desired logging level (set to error by default)",
+    )
+    # Options specific to this sample:
+    # This sample has no additional options, yet. If you add some, please add them here
+
+    args = parser.parse_args()
+
+    # Set logging level based on user input, or error by default
+    logging_level = getattr(logging, args.logging_level.upper())
+    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=False)
+    server.add_http_options({"verify": False})
+    server.use_server_version()
+    with server.auth.sign_in(tableau_auth):
+        # Monthly Schedule
+        # This schedule will run on the 15th of every month at 11:30PM
+        monthly_interval = TSC.MonthlyInterval(start_time=time(23, 30), interval_value=15)
+        monthly_schedule = TSC.ScheduleItem(
+            None,
+            None,
+            None,
+            None,
+            monthly_interval,
+        )
+
+        # Default to using first workbook found in server
+        all_workbook_items, pagination_item = server.workbooks.get()
+        my_workbook: TSC.WorkbookItem = all_workbook_items[0]
+
+        target_item = TSC.Target(
+            my_workbook.id,  # the id of the workbook or datasource
+            "workbook",  # alternatively can be "datasource"
+        )
+
+        extract_item = TSC.TaskItem(
+            None,
+            "FullRefresh",
+            None,
+            None,
+            None,
+            monthly_schedule,
+            None,
+            target_item,
+        )
+
+        try:
+            response = server.tasks.create(extract_item)
+            print(response)
+        except Exception as e:
+            print(e)
+
+
+if __name__ == "__main__":
+    main()

{tableauserverclient-0.25 → tableauserverclient-0.27.post0.dev1}/samples/create_group.py

@@ -20,14 +20,10 @@ from tableauserverclient import ServerResponseError
 def main():
     parser = argparse.ArgumentParser(description="Creates a sample user group.")
     # Common options; please keep those in sync across all samples
-    parser.add_argument("--server", "-s", required=True, help="server address")
+    parser.add_argument("--server", "-s", help="server address")
     parser.add_argument("--site", "-S", help="site name")
-    parser.add_argument(
-        "--token-name", "-p", required=True, help="name of the personal access token used to sign into the server"
-    )
-    parser.add_argument(
-        "--token-value", "-v", required=True, help="value of the personal access token used to sign into the server"
-    )
+    parser.add_argument("--token-name", "-p", help="name of the personal access token used to sign into the server")
+    parser.add_argument("--token-value", "-v", help="value of the personal access token used to sign into the server")
     parser.add_argument(
         "--logging-level",
         "-l",

{tableauserverclient-0.25 → tableauserverclient-0.27.post0.dev1}/samples/create_project.py

@@ -28,14 +28,10 @@ def create_project(server, project_item, samples=False):
 def main():
     parser = argparse.ArgumentParser(description="Create new projects.")
     # Common options; please keep those in sync across all samples
-    parser.add_argument("--server", "-s", required=True, help="server address")
+    parser.add_argument("--server", "-s", help="server address")
     parser.add_argument("--site", "-S", help="site name")
-    parser.add_argument(
-        "--token-name", "-p", required=True, help="name of the personal access token used to sign into the server"
-    )
-    parser.add_argument(
-        "--token-value", "-v", required=True, help="value of the personal access token used to sign into the server"
-    )
+    parser.add_argument("--token-name", "-p", help="name of the personal access token used to sign into the server")
+    parser.add_argument("--token-value", "-v", help="value of the personal access token used to sign into the server")
     parser.add_argument(
         "--logging-level",
         "-l",
@@ -61,7 +57,14 @@ def main():
         server.use_server_version()
 
         # Without parent_id specified, projects are created at the top level.
-        top_level_project = TSC.ProjectItem(name="Top Level Project")
+        # With the publish-samples attribute, the project will be created with sample items
+        top_level_project = TSC.ProjectItem(
+            name="Top Level Project",
+            description="A sample tsc project",
+            content_permissions=None,
+            parent_id=None,
+            samples=True,
+        )
         top_level_project = create_project(server, top_level_project)
 
         # Specifying parent_id creates a nested projects.

{tableauserverclient-0.25 → tableauserverclient-0.27.post0.dev1}/samples/create_schedules.py

@@ -17,14 +17,10 @@ import tableauserverclient as TSC
 def main():
     parser = argparse.ArgumentParser(description="Creates sample schedules for each type of frequency.")
     # Common options; please keep those in sync across all samples
-    parser.add_argument("--server", "-s", required=True, help="server address")
+    parser.add_argument("--server", "-s", help="server address")
     parser.add_argument("--site", "-S", help="site name")
-    parser.add_argument(
-        "--token-name", "-p", required=True, help="name of the personal access token used to sign into the server"
-    )
-    parser.add_argument(
-        "--token-value", "-v", required=True, help="value of the personal access token used to sign into the server"
-    )
+    parser.add_argument("--token-name", "-p", help="name of the personal access token used to sign into the server")
+    parser.add_argument("--token-value", "-v", help="value of the personal access token used to sign into the server")
     parser.add_argument(
         "--logging-level",
         "-l",

{tableauserverclient-0.25 → tableauserverclient-0.27.post0.dev1}/samples/explore_datasource.py

@@ -18,14 +18,10 @@ import tableauserverclient as TSC
 def main():
     parser = argparse.ArgumentParser(description="Explore datasource functions supported by the Server API.")
     # Common options; please keep those in sync across all samples
-    parser.add_argument("--server", "-s", required=True, help="server address")
+    parser.add_argument("--server", "-s", help="server address")
     parser.add_argument("--site", "-S", help="site name")
-    parser.add_argument(
-        "--token-name", "-p", required=True, help="name of the personal access token used to sign into the server"
-    )
-    parser.add_argument(
-        "--token-value", "-v", required=True, help="value of the personal access token used to sign into the server"
-    )
+    parser.add_argument("--token-name", "-p", help="name of the personal access token used to sign into the server")
+    parser.add_argument("--token-value", "-v", help="value of the personal access token used to sign into the server")
     parser.add_argument(
         "--logging-level",
         "-l",

tableauserverclient-0.27.post0.dev1/samples/explore_favorites.py

@@ -0,0 +1,85 @@
+# This script demonstrates how to get all favorites, or add/delete a favorite.
+
+import argparse
+import logging
+import tableauserverclient as TSC
+from tableauserverclient import Resource
+
+
+def main():
+    parser = argparse.ArgumentParser(description="Explore favoriting functions supported by the Server API.")
+    # Common options; please keep those in sync across all samples
+    parser.add_argument("--server", "-s", help="server address")
+    parser.add_argument("--site", "-S", help="site name")
+    parser.add_argument("--token-name", "-p", help="name of the personal access token used to sign into the server")
+    parser.add_argument("--token-value", "-v", help="value of the personal access token used to sign into the server")
+    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()
+
+    # Set logging level based on user input, or error by default
+    logging_level = getattr(logging, args.logging_level.upper())
+    logging.basicConfig(level=logging_level)
+
+    # SIGN IN
+    tableau_auth = TSC.PersonalAccessTokenAuth(args.token_name, args.token_value, site_id=args.site)
+    server = TSC.Server(args.server, use_server_version=True)
+    with server.auth.sign_in(tableau_auth):
+        print(server)
+        my_workbook = None
+        my_view = None
+        my_datasource = None
+
+        # get all favorites on site for the logged on user
+        user: TSC.UserItem = TSC.UserItem()
+        user.id = server.user_id
+        print("Favorites for user: {}".format(user.id))
+        server.favorites.get(user)
+        print(user.favorites)
+
+        # get list of workbooks
+        all_workbook_items, pagination_item = server.workbooks.get()
+        if all_workbook_items is not None and len(all_workbook_items) > 0:
+            my_workbook: TSC.WorkbookItem = all_workbook_items[0]
+            server.favorites.add_favorite(server, user, Resource.Workbook.name(), all_workbook_items[0])
+            print(
+                "Workbook added to favorites. Workbook Name: {}, Workbook ID: {}".format(
+                    my_workbook.name, my_workbook.id
+                )
+            )
+            views = server.workbooks.populate_views(my_workbook)
+            if views is not None and len(views) > 0:
+                my_view = views[0]
+                server.favorites.add_favorite_view(user, my_view)
+                print("View added to favorites. View Name: {}, View ID: {}".format(my_view.name, my_view.id))
+
+        all_datasource_items, pagination_item = server.datasources.get()
+        if all_datasource_items:
+            my_datasource = all_datasource_items[0]
+        server.favorites.add_favorite_datasource(user, my_datasource)
+        print(
+            "Datasource added to favorites. Datasource Name: {}, Datasource ID: {}".format(
+                my_datasource.name, my_datasource.id
+            )
+        )
+
+    server.favorites.delete_favorite_workbook(user, my_workbook)
+    print(
+        "Workbook deleted from favorites. Workbook Name: {}, Workbook ID: {}".format(my_workbook.name, my_workbook.id)
+    )
+
+    server.favorites.delete_favorite_view(user, my_view)
+    print("View deleted from favorites. View Name: {}, View ID: {}".format(my_view.name, my_view.id))
+
+    server.favorites.delete_favorite_datasource(user, my_datasource)
+    print(
+        "Datasource deleted from favorites. Datasource Name: {}, Datasource ID: {}".format(
+            my_datasource.name, my_datasource.id
+        )
+    )

{tableauserverclient-0.25 → tableauserverclient-0.27.post0.dev1}/samples/explore_site.py

@@ -14,14 +14,10 @@ import tableauserverclient as TSC
 def main():
     parser = argparse.ArgumentParser(description="Explore site updates by the Server API.")
     # Common options; please keep those in sync across all samples
-    parser.add_argument("--server", "-s", required=True, help="server address")
+    parser.add_argument("--server", "-s", help="server address")
     parser.add_argument("--site", "-S", help="site name")
-    parser.add_argument(
-        "--token-name", "-p", required=True, help="name of the personal access token used to sign into the server"
-    )
-    parser.add_argument(
-        "--token-value", "-v", required=True, help="value of the personal access token used to sign into the server"
-    )
+    parser.add_argument("--token-name", "-p", help="name of the personal access token used to sign into the server")
+    parser.add_argument("--token-value", "-v", help="value of the personal access token used to sign into the server")
     parser.add_argument(
         "--logging-level",
         "-l",

{tableauserverclient-0.25 → tableauserverclient-0.27.post0.dev1}/samples/explore_webhooks.py

@@ -19,14 +19,10 @@ import tableauserverclient as TSC
 def main():
     parser = argparse.ArgumentParser(description="Explore webhook functions supported by the Server API.")
     # Common options; please keep those in sync across all samples
-    parser.add_argument("--server", "-s", required=True, help="server address")
+    parser.add_argument("--server", "-s", help="server address")
     parser.add_argument("--site", "-S", help="site name")
-    parser.add_argument(
-        "--token-name", "-p", required=True, help="name of the personal access token used to sign into the server"
-    )
-    parser.add_argument(
-        "--token-value", "-v", required=True, help="value of the personal access token used to sign into the server"
-    )
+    parser.add_argument("--token-name", "-p", help="name of the personal access token used to sign into the server")
+    parser.add_argument("--token-value", "-v", help="value of the personal access token used to sign into the server")
     parser.add_argument(
         "--logging-level",
         "-l",

{tableauserverclient-0.25 → tableauserverclient-0.27.post0.dev1}/samples/explore_workbook.py

@@ -19,14 +19,10 @@ import tableauserverclient as TSC
 def main():
     parser = argparse.ArgumentParser(description="Explore workbook functions supported by the Server API.")
     # Common options; please keep those in sync across all samples
-    parser.add_argument("--server", "-s", required=True, help="server address")
+    parser.add_argument("--server", "-s", help="server address")
     parser.add_argument("--site", "-S", help="site name")
-    parser.add_argument(
-        "--token-name", "-p", required=True, help="name of the personal access token used to sign into the server"
-    )
-    parser.add_argument(
-        "--token-value", "-v", required=True, help="value of the personal access token used to sign into the server"
-    )
+    parser.add_argument("--token-name", "-p", help="name of the personal access token used to sign into the server")
+    parser.add_argument("--token-value", "-v", help="value of the personal access token used to sign into the server")
     parser.add_argument(
         "--logging-level",
         "-l",
@@ -40,6 +36,9 @@ def main():
     parser.add_argument(
         "--preview-image", "-i", metavar="FILENAME", help="filename (a .png file) to save the preview image"
     )
+    parser.add_argument(
+        "--powerpoint", "-ppt", metavar="FILENAME", help="filename (a .ppt file) to save the powerpoint deck"
+    )
 
     args = parser.parse_args()
 
@@ -149,6 +148,13 @@ def main():
                 f.write(c.image)
             print("saved to " + filename)
 
+            if args.powerpoint:
+                # Populate workbook preview image
+                server.workbooks.populate_powerpoint(sample_workbook)
+                with open(args.powerpoint, "wb") as f:
+                    f.write(sample_workbook.powerpoint)
+                print("\nDownloaded powerpoint of workbook to {}".format(os.path.abspath(args.powerpoint)))
+
             if args.delete:
                 print("deleting {}".format(c.id))
                 unlucky = TSC.CustomViewItem(c.id)

{tableauserverclient-0.25 → tableauserverclient-0.27.post0.dev1}/samples/export.py

@@ -14,14 +14,10 @@ import tableauserverclient as TSC
 def main():
     parser = argparse.ArgumentParser(description="Export a view as an image, PDF, or CSV")
     # Common options; please keep those in sync across all samples
-    parser.add_argument("--server", "-s", required=True, help="server address")
+    parser.add_argument("--server", "-s", help="server address")
     parser.add_argument("--site", "-S", help="site name")
-    parser.add_argument(
-        "--token-name", "-p", required=True, help="name of the personal access token used to sign into the server"
-    )
-    parser.add_argument(
-        "--token-value", "-v", required=True, help="value of the personal access token used to sign into the server"
-    )
+    parser.add_argument("--token-name", "-p", help="name of the personal access token used to sign into the server")
+    parser.add_argument("--token-value", "-v", help="value of the personal access token used to sign into the server")
     parser.add_argument(
         "--logging-level",
         "-l",

{tableauserverclient-0.25 → tableauserverclient-0.27.post0.dev1}/samples/extracts.py

@@ -19,14 +19,10 @@ import tableauserverclient as TSC
 def main():
     parser = argparse.ArgumentParser(description="Explore extract functions supported by the Server API.")
     # Common options; please keep those in sync across all samples
-    parser.add_argument("--server", "-s", required=True, help="server address")
+    parser.add_argument("--server", "-s", help="server address")
     parser.add_argument("--site", help="site name")
-    parser.add_argument(
-        "--token-name", "-tn", required=True, help="name of the personal access token used to sign into the server"
-    )
-    parser.add_argument(
-        "--token-value", "-tv", required=True, help="value of the personal access token used to sign into the server"
-    )
+    parser.add_argument("--token-name", "-tn", help="name of the personal access token used to sign into the server")
+    parser.add_argument("--token-value", "-tv", help="value of the personal access token used to sign into the server")
     parser.add_argument(
         "--logging-level",
         "-l",

{tableauserverclient-0.25 → tableauserverclient-0.27.post0.dev1}/samples/filter_sort_groups.py

@@ -26,14 +26,10 @@ def create_example_group(group_name="Example Group", server=None):
 def main():
     parser = argparse.ArgumentParser(description="Filter and sort groups.")
     # Common options; please keep those in sync across all samples
-    parser.add_argument("--server", "-s", required=True, help="server address")
+    parser.add_argument("--server", "-s", help="server address")
     parser.add_argument("--site", "-S", help="site name")
-    parser.add_argument(
-        "--token-name", "-p", required=True, help="name of the personal access token used to sign into the server"
-    )
-    parser.add_argument(
-        "--token-value", "-v", required=True, help="value of the personal access token used to sign into the server"
-    )
+    parser.add_argument("--token-name", "-p", help="name of the personal access token used to sign into the server")
+    parser.add_argument("--token-value", "-v", help="value of the personal access token used to sign into the server")
     parser.add_argument(
         "--logging-level",
         "-l",

{tableauserverclient-0.25 → tableauserverclient-0.27.post0.dev1}/samples/filter_sort_projects.py

@@ -29,14 +29,10 @@ def create_example_project(
 def main():
     parser = argparse.ArgumentParser(description="Filter and sort projects.")
     # Common options; please keep those in sync across all samples
-    parser.add_argument("--server", "-s", required=True, help="server address")
+    parser.add_argument("--server", "-s", help="server address")
     parser.add_argument("--site", "-S", help="site name")
-    parser.add_argument(
-        "--token-name", "-p", required=True, help="name of the personal access token used to sign into the server"
-    )
-    parser.add_argument(
-        "--token-value", "-v", required=True, help="value of the personal access token used to sign into the server"
-    )
+    parser.add_argument("--token-name", "-p", help="name of the personal access token used to sign into the server")
+    parser.add_argument("--token-value", "-v", help="value of the personal access token used to sign into the server")
     parser.add_argument(
         "--logging-level",
         "-l",

tableauserverclient-0.27.post0.dev1/samples/getting_started/1_hello_server.py

@@ -0,0 +1,21 @@
+####
+# Getting started Part One of Three
+# This script demonstrates how to use the Tableau Server Client to connect to a server
+# You don't need to have a site or any experience with Tableau to run it
+#
+####
+
+import tableauserverclient as TSC
+
+
+def main():
+    # This is the domain for Tableau's Developer Program
+    server_url = "https://10ax.online.tableau.com"
+    server = TSC.Server(server_url)
+    print("Connected to {}".format(server.server_info.baseurl))
+    print("Server information: {}".format(server.server_info))
+    print("Sign up for a test site at https://www.tableau.com/developer")
+
+
+if __name__ == "__main__":
+    main()

tableauserverclient-0.27.post0.dev1/samples/getting_started/2_hello_site.py

@@ -0,0 +1,50 @@
+####
+# Getting started Part Two of Three
+# This script demonstrates how to use the Tableau Server Client to
+# view the content on an existing site on Tableau Server/Online
+# It assumes that you have already got a site and can visit it in a browser
+#
+####
+
+import getpass
+import tableauserverclient as TSC
+
+
+# 0 - launch your Tableau site in a web browser and look at the url to set the values below
+def main():
+    # 1 - replace with your server domain: stop at the slash
+    server_url = "https://10ax.online.tableau.com"
+
+    # 2 - optional - change to false **for testing only** if you get a certificate error
+    use_ssl = True
+
+    server = TSC.Server(server_url, use_server_version=True, http_options={"verify": use_ssl})
+    print("Connected to {}".format(server.server_info.baseurl))
+
+    # 3 - replace with your site name exactly as it looks in the url
+    # e.g https://my-server/#/site/this-is-your-site-url-name/not-this-part
+    site_url_name = ""  # leave empty if there is no site name in the url (you are on the default site)
+
+    # 4 - replace with your username.
+    # REMEMBER: if you are using Tableau Online, your username is the entire email address
+    username = "your-username-here"
+    password = getpass.getpass("Your password:")  # so you don't save it in this file
+    tableau_auth = TSC.TableauAuth(username, password, site_id=site_url_name)
+
+    # OR instead of username+password, uncomment this section to use a Personal Access Token
+    # token_name = "your-token-name"
+    # token_value = "your-token-value-long-random-string"
+    # tableau_auth = TSC.PersonalAccessTokenAuth(token_name, token_value, site_id=site_url_name)
+
+    with server.auth.sign_in(tableau_auth):
+        projects, pagination = server.projects.get()
+        if projects:
+            print("{} projects".format(pagination.total_available))
+            project = projects[0]
+            print(project.name)
+
+        print("Done")
+
+
+if __name__ == "__main__":
+    main()