tableau · jacalata · Sep 12, 2022 · Oct 23, 2021 · Nov 9, 2021 · Nov 11, 2021
diff --git a/.github/workflows/publish-pypi.yml b/.github/workflows/publish-pypi.yml
@@ -6,8 +6,8 @@ name: Publish to PyPi
 on:
   workflow_dispatch:
   push:
-    branches:
-    - master
+    tags:
+      - 'v*.*.*'
 
 jobs:
   build-n-publish:
@@ -19,12 +19,13 @@ jobs:
           fetch-depth: 0
       - uses: actions/setup-python@v1
         with:
-          python-version: 3.8
+          python-version: 3.7
       - name: Build dist files
         run: |
           python -m pip install --upgrade pip
           pip install -e .[test]
-          python setup.py sdist --formats=gztar
+          python setup.py sdist --formats=gztar bdist_wheel
+          git describe --tag --dirty --always
       - name: Publish distribution 📦 to Test PyPI
         uses: pypa/gh-action-pypi-publish@release/v1  # license BSD-2
         with:

diff --git a/.github/workflows/run-tests.yml b/.github/workflows/run-tests.yml
@@ -29,7 +29,3 @@ jobs:
       if: always()
       run: |
         pytest test
-
-    - name: Run Mypy tests
-      run: |
-        mypy --show-error-codes --disable-error-code misc --disable-error-code import tableauserverclient test
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,13 +1,14 @@
-include versioneer.py
-include tableauserverclient/_version.py
+include CHANGELOG.md
+include contributing.md
+include CONTRIBUTORS.md
 include LICENSE
 include LICENSE.versioneer
 include README.md
-include CHANGELOG.md
+include tableauserverclient/_version.py
+include versioneer.py
 recursive-include docs *.md
 recursive-include samples *.py
 recursive-include samples *.txt
-recursive-include smoke *.py
 recursive-include test *.csv
 recursive-include test *.dict
 recursive-include test *.hyper
@@ -16,5 +17,6 @@ recursive-include test *.pdf
 recursive-include test *.png
 recursive-include test *.py
 recursive-include test *.xml
+recursive-include test *.tde
 global-include *.pyi
-global-include *.typed
+global-include *.typed
diff --git a/contributing.md b/contributing.md
@@ -57,9 +57,8 @@ somewhere.
 ## Getting Started
 
 ```shell
-pip install versioneer
-python setup.py build
-python setup.py test
+python -m build
+pytest
 ```
 
 ### To use your locally built version

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,7 +1,37 @@
 [build-system]
-requires = ["setuptools>=45.0", "versioneer-518", "wheel"]
+requires = ["setuptools>=45.0", "versioneer>=0.24", "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',
+    'packaging~=21.3',
+    'requests>=2.28',
+    'urllib3~=1.26.8',
+]
+requires-python = ">=3.7"
+classifiers = [
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.7",
+  "Programming Language :: Python :: 3.8",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10"
+]
+[project.urls]
+repository = "https://github.com/tableau/server-client-python"
+
+[project.optional-dependencies]
+test = ["argparse", "black", "mock", "mypy", "pytest>=7.0", "requests-mock>=1.0,<2.0"]
+
 [tool.black]
 line-length = 120
 target-version = ['py37', 'py38', 'py39', 'py310']
@@ -11,8 +41,10 @@ disable_error_code = [
     'misc',
     'import'
 ]
-files = [
-    "tableauserverclient",
-    "test"
-]
+files = ["tableauserverclient", "test"]
 show_error_codes = true
+ignore_missing_imports = true
+
+[tool.pytest.ini_options]
+testpaths = ["test"]
+addopts = "--junitxml=./test.junit.xml"
diff --git a/samples/create_group.py b/samples/create_group.py
@@ -8,10 +8,13 @@
 
 import argparse
 import logging
+import os
 
 from datetime import time
+from typing import List
 
 import tableauserverclient as TSC
+from tableauserverclient import ServerResponseError
 
 
 def main():
@@ -35,7 +38,7 @@ def main():
     )
     # Options specific to this sample
     # This sample has no additional options, yet. If you add some, please add them here
-
+    parser.add_argument("--file", help="csv file containing user info", required=False)
     args = parser.parse_args()
 
     # Set logging level based on user input, or error by default
@@ -45,9 +48,48 @@ def main():
     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):
+        # this code shows 3 different error codes that mean "resource is already in collection"
+        # 409009: group already exists on server
+        # 409107: user is already on site
+        # 409011: user is already in group
+
         group = TSC.GroupItem("test")
-        group = server.groups.create(group)
-        print(group)
+        try:
+            group = server.groups.create(group)
+        except TSC.server.endpoint.exceptions.ServerResponseError as rError:
+            if rError.code == "409009":
+                print("Group already exists")
+                group = server.groups.filter(name=group.name)[0]
+            else:
+                raise rError
+        server.groups.populate_users(group)
+        for user in group.users:
+            print(user.name)
+
+        if args.file:
+            filepath = os.path.abspath(args.file)
+            print("Add users to site from file {}:".format(filepath))
+            added: List[TSC.UserItem]
+            failed: List[TSC.UserItem, TSC.ServerResponseError]
+            added, failed = server.users.create_from_file(filepath)
+            for user, error in failed:
+                print(user, error.code)
+                if error.code == "409017":
+                    user = server.users.filter(name=user.name)[0]
+                    added.append(user)
+            print("Adding users to group:{}".format(added))
+            for user in added:
+                print("Adding user {}".format(user))
+                try:
+                    server.groups.add_user(group, user.id)
+                except ServerResponseError as serverError:
+                    if serverError.code == "409011":
+                        print("user {} is already a member of group {}".format(user.name, group.name))
+                    else:
+                        raise rError
+
+        for user in group.users:
+            print(user.name)
 
 
 if __name__ == "__main__":

diff --git a/samples/explore_site.py b/samples/explore_site.py
@@ -0,0 +1,83 @@
+####
+# This script demonstrates how to use the Tableau Server Client
+# to interact with sites.
+####
+
+import argparse
+import logging
+import os.path
+import sys
+
+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("--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(
+        "--logging-level",
+        "-l",
+        choices=["debug", "info", "error"],
+        default="error",
+        help="desired logging level (set to error by default)",
+    )
+
+    parser.add_argument("--delete")
+    parser.add_argument("--create")
+    parser.add_argument("--url")
+    parser.add_argument("--new_site_name")
+    parser.add_argument("--user_quota")
+    parser.add_argument("--storage_quota")
+    parser.add_argument("--status")
+
+    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)
+    new_site = None
+    with server.auth.sign_in(tableau_auth):
+        current_site = server.sites.get_by_id(server.site_id)
+
+        if args.delete:
+            print("You can only delete the site you are currently in")
+            print("Delete site `{}`?".format(current_site.name))
+            # server.sites.delete(server.site_id)
+
+        elif args.create:
+            new_site = TSC.SiteItem(args.create, args.url or args.create)
+            site_item = server.sites.create(new_site)
+            print(site_item)
+            # to do anything further with the site, you need to log into it
+            # if a PAT is required, that means going to the UI to create one
+
+        else:
+            new_site = current_site
+            print(current_site, "current user quota:", current_site.user_quota)
+            print("Remember, you can only update the site you are currently in")
+            if args.url:
+                new_site.content_url = args.url
+            if args.user_quota:
+                new_site.user_quota = args.user_quota
+            try:
+                updated_site = server.sites.update(new_site)
+                print(updated_site, "new user quota:", updated_site.user_quota)
+            except TSC.ServerResponseError as e:
+                print(e)
+
+
+if __name__ == "__main__":
+    main()
diff --git a/samples/list.py b/samples/list.py
@@ -59,7 +59,10 @@ def main():
         count = 0
         for resource in TSC.Pager(endpoint.get, options):
             count = count + 1
-            print(resource.id, resource.name)
+            # endpoint.populate_connections(resource)
+            print(resource.name[:18], " ")  # , resource._connections())
+            if count > 100:
+                break
         print("Total: {}".format(count))
 
 

diff --git a/samples/online_users.csv b/samples/online_users.csv
@@ -0,0 +1,2 @@
+ayoung@tableau.com, , , "Creator", None, Yes
+ahsiao@tableau.com, , , "Explorer", None, No
diff --git a/setup.cfg b/setup.cfg
@@ -1,27 +1,10 @@
-[wheel]
-universal = 1
-
-[pep8]
-max_line_length = 120
-
 # See the docstring in versioneer.py for instructions. Note that you must
 # re-run 'versioneer.py setup' after changing this section, and commit the
 # resulting files.
-
+# versioneer does not support pyproject.toml
 [versioneer]
 VCS = git
 style = pep440-pre
 versionfile_source = tableauserverclient/_version.py
 versionfile_build = tableauserverclient/_version.py
 tag_prefix = v
-#parentdir_prefix =
-
-[aliases]
-smoke=pytest
-
-[tool:pytest]
-testpaths = test smoke
-addopts = --junitxml=./test.junit.xml
-
-[mypy]
-ignore_missing_imports = True
diff --git a/setup.py b/setup.py
@@ -1,49 +1,22 @@
-import sys
 import versioneer
+from setuptools import setup
 
-try:
-    from setuptools import setup
-except ImportError:
-    from distutils.core import setup
-
-from os import path
-this_directory = path.abspath(path.dirname(__file__))
-with open(path.join(this_directory, 'README.md'), encoding='utf-8') as f:
-    long_description = f.read()
-
-# Only install pytest and runner when test command is run
-# This makes work easier for offline installs or low bandwidth machines
-needs_pytest = {'pytest', 'test', 'ptr'}.intersection(sys.argv)
-pytest_runner = ['pytest-runner'] if needs_pytest else []
-test_requirements = ['black', 'mock', 'pytest', 'requests-mock>=1.0,<2.0', 'mypy>=0.920']
-
+"""
+once versioneer 0.25 gets released, we can move this from setup.cfg to pyproject.toml
+[tool.versioneer]
+VCS = "git"
+style = "pep440-pre"
+versionfile_source = "tableauserverclient/_version.py"
+versionfile_build = "tableauserverclient/_version.py"
+tag_prefix = "v"
+"""
 setup(
-    name='tableauserverclient',
     version=versioneer.get_version(),
     cmdclass=versioneer.get_cmdclass(),
-    author='Tableau',
-    author_email='github@tableau.com',
-    url='https://github.com/tableau/server-client-python',
-    package_data={'tableauserverclient':['py.typed']},
+    # not yet sure how to move this to pyproject.toml
     packages=['tableauserverclient',
               'tableauserverclient.helpers',
               'tableauserverclient.models',
               'tableauserverclient.server',
               'tableauserverclient.server.endpoint'],
-    license='MIT',
-    description='A Python module for working with the Tableau Server REST API.',
-    long_description=long_description,
-    long_description_content_type='text/markdown',
-    test_suite='test',
-    setup_requires=pytest_runner,
-    install_requires=[
-        'defusedxml>=0.7.1',
-        'requests>=2.11,<3.0',
-    ],
-    python_requires='>3.7.0',
-    tests_require=test_requirements,
-    extras_require={
-        'test': test_requirements
-    },
-    zip_safe=False
 )
diff --git a/smoke/__init__.py b/smoke/__init__.py
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		ayoung@tableau.com, , , "Creator", None, Yes
		ahsiao@tableau.com, , , "Explorer", None, No