tableauserverclient 0.38__tar.gz → 0.40__tar.gz

{tableauserverclient-0.38 → tableauserverclient-0.40}/MANIFEST.in

@@ -4,8 +4,6 @@ include CONTRIBUTORS.md
 include LICENSE
 include LICENSE.versioneer
 include README.md
-include tableauserverclient/_version.py
-include versioneer.py
 recursive-include docs *.md
 recursive-include samples *.py
 recursive-include samples *.txt
@@ -18,5 +16,4 @@ recursive-include test *.png
 recursive-include test *.py
 recursive-include test *.xml
 recursive-include test *.tde
-global-include *.pyi
 global-include *.typed

{tableauserverclient-0.38 → tableauserverclient-0.40}/PKG-INFO

@@ -1,30 +1,8 @@
 Metadata-Version: 2.4
 Name: tableauserverclient
-Version: 0.38
+Version: 0.40
 Summary: A Python module for working with the Tableau Server REST API.
 Author-email: Tableau <github@tableau.com>
-License: The MIT License (MIT)
-        
-        Copyright (c) 2022 Tableau
-        
-        Permission is hereby granted, free of charge, to any person obtaining a copy
-        of this software and associated documentation files (the "Software"), to deal
-        in the Software without restriction, including without limitation the rights
-        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-        copies of the Software, and to permit persons to whom the Software is
-        furnished to do so, subject to the following conditions:
-        
-        The above copyright notice and this permission notice shall be included in all
-        copies or substantial portions of the Software.
-        
-        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-        SOFTWARE.
-        
 Project-URL: repository, https://github.com/tableau/server-client-python
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
@@ -36,20 +14,21 @@ Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
-License-File: LICENSE.versioneer
 Requires-Dist: defusedxml>=0.7.1
 Requires-Dist: packaging>=23.1
 Requires-Dist: requests>=2.32
-Requires-Dist: urllib3<3,>=2.2.2
+Requires-Dist: urllib3<3,>=2.6.0
 Requires-Dist: typing_extensions>=4.0
 Provides-Extra: test
-Requires-Dist: black==24.8; extra == "test"
+Requires-Dist: black==24.10; extra == "test"
 Requires-Dist: build; 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: pytest-xdist; extra == "test"
 Requires-Dist: requests-mock<2.0,>=1.0; extra == "test"
+Requires-Dist: types-requests>=2.32.4.20250913; extra == "test"
 Dynamic: license-file
 
 # Tableau Server Client (Python)

{tableauserverclient-0.38 → tableauserverclient-0.40}/pyproject.toml

@@ -1,5 +1,5 @@
 [build-system]
-requires = ["setuptools>=75.0", "versioneer[toml]==0.29", "wheel"]
+requires = ["setuptools>=77.0", "versioneer[toml]==0.29", "wheel"]
 build-backend = "setuptools.build_meta"
 
 [project]
@@ -8,14 +8,14 @@ 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"}
+license-files = ["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.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,19 @@ 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.package-data]
+# Only include data for tableauserverclient, not for samples, test, docs
+tableauserverclient = ["*"]
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["tableauserverclient*"]
+
+[tool.setuptools.dynamic]
+version = {attr = "versioneer.get_version"}
 
 [tool.black]
 line-length = 120
@@ -61,5 +72,5 @@ addopts = "--junitxml=./test.junit.xml"
 VCS = "git"
 style = "pep440-pre"
 versionfile_source = "tableauserverclient/bin/_version.py"
-versionfile_build = "tableauserverclient/bin/_version.py"
+versionfile_build = "_version.py"
 tag_prefix = "v"

tableauserverclient-0.40/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()

tableauserverclient-0.40/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()

tableauserverclient-0.40/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()

tableauserverclient-0.40/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()

{tableauserverclient-0.38 → tableauserverclient-0.40}/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__":

tableauserverclient-0.40/setup.py

@@ -0,0 +1,8 @@
+import versioneer
+from setuptools import setup
+
+setup(
+    # This line is required to set the version number when building the wheel
+    # not yet sure how to move this to pyproject.toml - it may require work in versioneer
+    cmdclass=versioneer.get_cmdclass()
+)

{tableauserverclient-0.38 → tableauserverclient-0.40}/tableauserverclient/__init__.py

@@ -2,6 +2,7 @@ from tableauserverclient.bin._version import get_versions
 from tableauserverclient.namespace import NEW_NAMESPACE as DEFAULT_NAMESPACE
 from tableauserverclient.models import (
     BackgroundJobItem,
+    CollectionItem,
     ColumnItem,
     ConnectionCredentials,
     ConnectionItem,
@@ -12,6 +13,8 @@ from tableauserverclient.models import (
     DatabaseItem,
     DataFreshnessPolicyItem,
     DatasourceItem,
+    ExtensionsServer,
+    ExtensionsSiteSettings,
     FavoriteItem,
     FlowItem,
     FlowRunItem,
@@ -35,8 +38,10 @@ from tableauserverclient.models import (
     ProjectItem,
     Resource,
     RevisionItem,
+    SafeExtension,
     ScheduleItem,
     SiteAuthConfiguration,
+    SiteOIDCConfiguration,
     SiteItem,
     ServerInfoItem,
     SubscriptionItem,
@@ -72,7 +77,7 @@ from tableauserverclient.server import (
 
 __all__ = [
     "BackgroundJobItem",
-    "BackgroundJobItem",
+    "CollectionItem",
     "ColumnItem",
     "ConnectionCredentials",
     "ConnectionItem",
@@ -86,6 +91,8 @@ __all__ = [
     "DEFAULT_NAMESPACE",
     "DQWItem",
     "ExcelRequestOptions",
+    "ExtensionsServer",
+    "ExtensionsSiteSettings",
     "FailedSignInError",
     "FavoriteItem",
     "FileuploadItem",
@@ -119,12 +126,14 @@ __all__ = [
     "RequestOptions",
     "Resource",
     "RevisionItem",
+    "SafeExtension",
     "ScheduleItem",
     "Server",
     "ServerInfoItem",
     "ServerResponseError",
     "SiteItem",
     "SiteAuthConfiguration",
+    "SiteOIDCConfiguration",
     "Sort",
     "SubscriptionItem",
     "TableauAuth",
@@ -139,7 +148,3 @@ __all__ = [
     "WeeklyInterval",
     "WorkbookItem",
 ]
-
-from .bin import _version
-
-__version__ = _version.get_versions()["version"]

tableauserverclient-0.40/tableauserverclient/bin/__init__.py

@@ -0,0 +1,3 @@
+# generated during initial setup of versioneer
+from . import _version
+__version__ = _version.get_versions()['version']

{tableauserverclient-0.38 → tableauserverclient-0.40}/tableauserverclient/bin/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2025-05-15T14:21:50-0700",
+ "date": "2026-02-03T12:18:13-0800",
  "dirty": false,
  "error": null,
- "full-revisionid": "cda018b684c98200f3f9de11e379ba2ca3b1b3fe",
- "version": "0.38"
+ "full-revisionid": "d4b27f42d897883f8b8d0cb5b7edb558df2cbfb6",
+ "version": "0.40"
 }
 '''  # END VERSION_JSON
 

{tableauserverclient-0.38 → tableauserverclient-0.40}/tableauserverclient/models/__init__.py

@@ -1,3 +1,4 @@
+from tableauserverclient.models.collection_item import CollectionItem
 from tableauserverclient.models.column_item import ColumnItem
 from tableauserverclient.models.connection_credentials import ConnectionCredentials
 from tableauserverclient.models.connection_item import ConnectionItem
@@ -9,6 +10,7 @@ from tableauserverclient.models.data_freshness_policy_item import DataFreshnessP
 from tableauserverclient.models.datasource_item import DatasourceItem
 from tableauserverclient.models.dqw_item import DQWItem
 from tableauserverclient.models.exceptions import UnpopulatedPropertyError
+from tableauserverclient.models.extensions_item import ExtensionsServer, ExtensionsSiteSettings, SafeExtension
 from tableauserverclient.models.favorites_item import FavoriteItem
 from tableauserverclient.models.fileupload_item import FileuploadItem
 from tableauserverclient.models.flow_item import FlowItem
@@ -30,6 +32,7 @@ from tableauserverclient.models.linked_tasks_item import (
 )
 from tableauserverclient.models.location_item import LocationItem
 from tableauserverclient.models.metric_item import MetricItem
+from tableauserverclient.models.oidc_item import SiteOIDCConfiguration
 from tableauserverclient.models.pagination_item import PaginationItem
 from tableauserverclient.models.permissions_item import PermissionsRule, Permission
 from tableauserverclient.models.project_item import ProjectItem
@@ -52,6 +55,7 @@ from tableauserverclient.models.workbook_item import WorkbookItem
 from tableauserverclient.models.extract_item import ExtractItem
 
 __all__ = [
+    "CollectionItem",
     "ColumnItem",
     "ConnectionCredentials",
     "ConnectionItem",
@@ -79,6 +83,7 @@ __all__ = [
     "BackgroundJobItem",
     "LocationItem",
     "MetricItem",
+    "SiteOIDCConfiguration",
     "PaginationItem",
     "Permission",
     "PermissionsRule",
@@ -88,6 +93,7 @@ __all__ = [
     "ServerInfoItem",
     "SiteAuthConfiguration",
     "SiteItem",
+    "SiteOIDCConfiguration",
     "SubscriptionItem",
     "TableItem",
     "TableauAuth",
@@ -108,4 +114,7 @@ __all__ = [
     "LinkedTaskStepItem",
     "LinkedTaskFlowRunItem",
     "ExtractItem",
+    "ExtensionsServer",
+    "ExtensionsSiteSettings",
+    "SafeExtension",
 ]

tableauserverclient-0.40/tableauserverclient/models/collection_item.py

@@ -0,0 +1,52 @@
+from datetime import datetime
+from typing import Optional
+from xml.etree.ElementTree import Element
+
+from defusedxml.ElementTree import fromstring
+from typing_extensions import Self
+
+from tableauserverclient.datetime_helpers import parse_datetime
+from tableauserverclient.models.user_item import UserItem
+
+
+class CollectionItem:
+    def __init__(self) -> None:
+        self.id: Optional[str] = None
+        self.name: Optional[str] = None
+        self.description: Optional[str] = None
+        self.created_at: Optional[datetime] = None
+        self.updated_at: Optional[datetime] = None
+        self.owner: Optional[UserItem] = None
+        self.total_item_count: Optional[int] = None
+        self.permissioned_item_count: Optional[int] = None
+        self.visibility: Optional[str] = None  # Assuming visibility is a string, adjust as necessary
+
+    @classmethod
+    def from_response(cls, response: bytes, ns) -> list[Self]:
+        parsed_response = fromstring(response)
+
+        collection_elements = parsed_response.findall(".//t:collection", namespaces=ns)
+        if not collection_elements:
+            raise ValueError("No collection element found in the response")
+
+        collections = [cls.from_xml(c, ns) for c in collection_elements]
+        return collections
+
+    @classmethod
+    def from_xml(cls, xml: Element, ns) -> Self:
+        collection_item = cls()
+        collection_item.id = xml.get("id")
+        collection_item.name = xml.get("name")
+        collection_item.description = xml.get("description")
+        collection_item.created_at = parse_datetime(xml.get("createdAt"))
+        collection_item.updated_at = parse_datetime(xml.get("updatedAt"))
+        owner_element = xml.find(".//t:owner", namespaces=ns)
+        if owner_element is not None:
+            collection_item.owner = UserItem.from_xml(owner_element, ns)
+        else:
+            collection_item.owner = None
+        collection_item.total_item_count = int(xml.get("totalItemCount", 0))
+        collection_item.permissioned_item_count = int(xml.get("permissionedItemCount", 0))
+        collection_item.visibility = xml.get("visibility")
+
+        return collection_item