Merge branch 'development' into jac/release-automation

Author: jacalata

.github/workflows/publish-pypi.yml

@@ -22,7 +22,7 @@ jobs:
           fetch-depth: 0
       - uses: actions/setup-python@v5
         with:
-          python-version: 3.9
+          python-version: 3.13
       - name: Build dist files
         run: |
           python -m pip install --upgrade pip

.github/workflows/run-tests.yml

@@ -13,7 +13,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: ['3.9', '3.10', '3.11', '3.12', '3.13']
+        python-version: ['3.10', '3.11', '3.12', '3.13', '3.14', '3.14t']
 
     runs-on: ${{ matrix.os }}
 
@@ -38,6 +38,7 @@ jobs:
       uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
+        allow-prereleases: ${{ matrix.allow-prereleases || false }}
 
     - name: Install dependencies
       run: |
@@ -47,7 +48,7 @@ jobs:
     - name: Test with pytest
       if: always()
       run: |
-        pytest test
+        pytest test -n auto
 
     - name: Test build
       if: always()

CODEOWNERS

@@ -0,0 +1,2 @@
+#ECCN:Open Source
+#GUSINFO:Open Source,Open Source Workflow

pyproject.toml

@@ -15,7 +15,7 @@ dependencies = [
     'defusedxml>=0.7.1',  # latest as at 7/31/23
     'packaging>=23.1',   # latest as at 7/31/23
     'requests>=2.32',  # latest as at 7/31/23
-    'urllib3>=2.2.2,<3',
+    'urllib3>=2.6.0,<3',
     'typing_extensions>=4.0',
 ]
 requires-python = ">=3.9"
@@ -32,8 +32,8 @@ classifiers = [
 repository = "https://github.com/tableau/server-client-python"
 
 [project.optional-dependencies]
-test = ["black==24.8", "build", "mypy==1.4", "pytest>=7.0", "pytest-cov", "pytest-subtests",
-    "requests-mock>=1.0,<2.0"]
+test = ["black==24.10", "build", "mypy==1.4", "pytest>=7.0", "pytest-cov", "pytest-subtests",
+    "pytest-xdist", "requests-mock>=1.0,<2.0", "types-requests>=2.32.4.20250913"]
 
 [tool.setuptools.packages.find]
 where = ["tableauserverclient", "tableauserverclient.helpers", "tableauserverclient.models", "tableauserverclient.server", "tableauserverclient.server.endpoint"]

samples/create_user.py

@@ -0,0 +1,73 @@
+####
+# This script demonstrates how to create a user using the Tableau
+# Server Client.
+#
+# To run the script, you must have installed Python 3.7 or later.
+####
+
+
+import argparse
+import logging
+import os
+import sys
+from typing import Sequence
+
+import tableauserverclient as TSC
+
+
+def parse_args(args: Sequence[str] | None) -> argparse.Namespace:
+    """
+    Parse command line parameters
+    """
+    if args is None:
+        args = sys.argv[1:]
+    parser = argparse.ArgumentParser(description="Creates a sample user group.")
+    # 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
+    parser.add_argument("--role", "-r", help="Site Role for the new user", default="Unlicensed")
+    parser.add_argument(
+        "--user",
+        "-u",
+        help="Username for the new user. If using active directory, it should be in the format of SAMAccountName@FullyQualifiedDomainName",
+    )
+    parser.add_argument(
+        "--email", "-e", help="Email address of the new user. If using active directory, this field is optional."
+    )
+
+    return parser.parse_args(args)
+
+
+def main():
+    args = parse_args(None)
+
+    # 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=True, http_options={"verify": False})
+    with server.auth.sign_in(tableau_auth):
+        # this code shows 2 different error codes for common mistakes
+        # 400013: Invalid site role
+        # 409000: user already exists on site
+
+        user = TSC.UserItem(args.user, args.role)
+        if args.email:
+            user.email = args.email
+        user = server.users.add(user)
+
+
+if __name__ == "__main__":
+    main()

samples/metadata_paginated_query.py

@@ -0,0 +1,87 @@
+####
+# This script demonstrates how to use the metadata API to query information on a published data source
+#
+# To run the script, you must have installed Python 3.7 or later.
+####
+
+import argparse
+import logging
+from pprint import pprint
+
+import tableauserverclient as TSC
+
+
+def main():
+    parser = argparse.ArgumentParser(description="Use the metadata API to get information on a published data source.")
+    # 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", "-n", 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
+    parser.add_argument(
+        "datasource_name",
+        nargs="?",
+        help="The name of the published datasource. If not present, we query all data sources.",
+    )
+
+    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 to server
+    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):
+        # Execute the query
+        result = server.metadata.query(
+            """
+            # Query must declare that it accepts first and afterToken variables
+            query paged($first:Int, $afterToken:String) {
+              workbooksConnection(first: $first, after:$afterToken) {
+                nodes {
+                  luid
+                  name
+                  projectName
+                  description
+                }
+                totalCount
+                pageInfo {
+                  endCursor
+                  hasNextPage
+                }
+              }
+            }
+            """,
+            # "first" adjusts the page size. Here we set it to 5 to demonstrate pagination.
+            # Set it to a higher number to reduce the number of pages. Including
+            # first and afterToken is optional, and if not included, TSC will
+            # use its default page size of 100.
+            variables={"first": 5, "afterToken": None},
+        )
+
+        # Multiple pages are captured in result["pages"]. Each page contains
+        # the result of one execution of the query above.
+        for page in result["pages"]:
+            # Display warnings/errors (if any)
+            if page.get("errors"):
+                print("### Errors/Warnings:")
+                pprint(result["errors"])
+
+            # Print the results
+            if result.get("data"):
+                print("### Results:")
+                pprint(result["data"]["workbooksConnection"]["nodes"])
+
+
+if __name__ == "__main__":
+    main()

samples/update_connection_auth.py

@@ -0,0 +1,62 @@
+import argparse
+import logging
+import tableauserverclient as TSC
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        description="Update a single connection on a datasource or workbook to embed credentials"
+    )
+
+    # Common options
+    parser.add_argument("--server", "-s", help="Server address", required=True)
+    parser.add_argument("--site", "-S", help="Site name", required=True)
+    parser.add_argument("--token-name", "-p", help="Personal access token name", required=True)
+    parser.add_argument("--token-value", "-v", help="Personal access token value", required=True)
+    parser.add_argument(
+        "--logging-level",
+        "-l",
+        choices=["debug", "info", "error"],
+        default="error",
+        help="Logging level (default: error)",
+    )
+
+    # Resource and connection details
+    parser.add_argument("resource_type", choices=["workbook", "datasource"])
+    parser.add_argument("resource_id", help="Workbook or datasource ID")
+    parser.add_argument("connection_id", help="Connection ID to update")
+    parser.add_argument("datasource_username", help="Username to set for the connection")
+    parser.add_argument("datasource_password", help="Password to set for the connection")
+    parser.add_argument("authentication_type", help="Authentication type")
+
+    args = parser.parse_args()
+
+    # Logging setup
+    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=True)
+
+    with server.auth.sign_in(tableau_auth):
+        endpoint = {"workbook": server.workbooks, "datasource": server.datasources}.get(args.resource_type)
+
+        update_function = endpoint.update_connection
+        resource = endpoint.get_by_id(args.resource_id)
+        endpoint.populate_connections(resource)
+
+        connections = [conn for conn in resource.connections if conn.id == args.connection_id]
+        assert len(connections) == 1, f"Connection ID '{args.connection_id}' not found."
+
+        connection = connections[0]
+        connection.username = args.datasource_username
+        connection.password = args.datasource_password
+        connection.auth_type = args.authentication_type
+        connection.embed_password = True
+
+        updated_connection = update_function(resource, connection)
+        print(f"Updated connection: {updated_connection.__dict__}")
+
+
+if __name__ == "__main__":
+    main()

samples/update_connections_auth.py

@@ -0,0 +1,64 @@
+import argparse
+import logging
+import tableauserverclient as TSC
+
+
+def main():
+    parser = argparse.ArgumentParser(description="Bulk update all workbook or datasource connections")
+
+    # Common options
+    parser.add_argument("--server", "-s", help="Server address", required=True)
+    parser.add_argument("--site", "-S", help="Site name", required=True)
+    parser.add_argument("--token-name", "-p", help="Personal access token name", required=True)
+    parser.add_argument("--token-value", "-v", help="Personal access token value", required=True)
+    parser.add_argument(
+        "--logging-level",
+        "-l",
+        choices=["debug", "info", "error"],
+        default="error",
+        help="Logging level (default: error)",
+    )
+
+    # Resource-specific
+    parser.add_argument("resource_type", choices=["workbook", "datasource"])
+    parser.add_argument("resource_id")
+    parser.add_argument("datasource_username")
+    parser.add_argument("authentication_type")
+    parser.add_argument("--datasource_password", default=None, help="Datasource password (optional)")
+    parser.add_argument(
+        "--embed_password", default="true", choices=["true", "false"], help="Embed password (default: true)"
+    )
+
+    args = parser.parse_args()
+
+    # Set logging level
+    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=True)
+
+    with server.auth.sign_in(tableau_auth):
+        endpoint = {"workbook": server.workbooks, "datasource": server.datasources}.get(args.resource_type)
+
+        resource = endpoint.get_by_id(args.resource_id)
+        endpoint.populate_connections(resource)
+
+        connection_luids = [conn.id for conn in resource.connections]
+        embed_password = args.embed_password.lower() == "true"
+
+        # Call unified update_connections method
+        connection_items = endpoint.update_connections(
+            resource,
+            connection_luids=connection_luids,
+            authentication_type=args.authentication_type,
+            username=args.datasource_username,
+            password=args.datasource_password,
+            embed_password=embed_password,
+        )
+
+        print(f"Updated connections on {args.resource_type} {args.resource_id}: {connection_items}")
+
+
+if __name__ == "__main__":
+    main()

samples/update_datasource_data.py

@@ -76,7 +76,7 @@ def main():
         print("Waiting for job...")
         # `wait_for_job` will throw if the job isn't executed successfully
         job = server.jobs.wait_for_job(job)
-        print("Job finished succesfully")
+        print("Job finished successfully")
 
 
 if __name__ == "__main__":