tableauserverclient

What's Changed

• feat: New APIs: Update multiple connections in a single workbook/datasource (#1638)

• feat: enable toggling attribute capture for a site (#1619)

• feat: support OIDC endpoints (#1630)

• feat: add WebAuthoringForFlows capability to Permission class (#1642)

• feat: support collections in favorites (#1647)

• feat: Add UAT (unified access token) support to JWT login (#1671)

• feat: Update permissions_item.py --added ExtractRefresh attribute (#1617) (#1669)

• feat: make refresh consistent between endpoints (#1665)

• feat: make ResourceReference hashable (#1668) Closes #1666

• feat: delete view (#1712)

• feat: batch create schedule (#1714)

• feat: users csv import (#1409)

• feat: implement users bulk_remove

• feat: enable idp_configuration_id in bulk_add

• feat: support extensions api (#1672)

• feat: Add support for receiving "Customized Monthly" schedule intervals (#1670)

• feat: implement #816: project.get_by_id (#1736)

• feat: enable retrieving only owned workbooks by @jorwoods in #1594

• feat: Add fields:all support by @jorwoods in #1563

• feat: Add SSL option for connecting to Tableau Server with a weaker DH key length by @bcantoni in #1596

• 1580 list extracts on schedule by @casey-crawford-cfa in #1604

• fix: put special fields first (#1622) Closes #1620

• fix: virtual connections username (#1628) Closes #1626

• fix: add contentType to tags batch actions (#1643)

• fix: datasource owner/project missing parsing (#1700)

• fix: datasource description update and publish (#1682)

• fix: windows decoding error

• fix: assert on warning instead of ignore

• fix: add workbook and view setter for custom view (#1730)

• fix: handle parameters for view filters (#1633)

Full Changelog: v0.38...v0.39

What's Changed

• v0.38 - IDP configuration by @jacalata in #1606

• docs: docstrings for schedules and intervals (#1528)

• docs: Docstrings for new fields

• feat: enable retrieving only owned workbooks

• feat: Add support for multiple IDPs (jorwoods)

• feat: Add fields:all support (#1563)

• feat: project support all fields

• feat: groups all fields

• feat: views support all fields

• feat: user support all fields

• feat: workbook support all fields

• feat: datasourceitem all fields

• feat: add fields methods to QuerySet

• feat: add owner attribute to project

• Add SSL option for connecting to Tableau Server with a weaker DH key length
  Fixes #1582

• feat: 1580 list extracts on schedule (#1604)

• chore: type hint database and table objects (#1593)

• ci: Switch Slack action to use ubuntu-latest like our other actions.

Co-authored-by: Jordan Woods jorwoods@users.noreply.github.com
Co-authored-by: Jordan Woods 13803242+jorwoods@users.noreply.github.com
Co-authored-by: Brian Cantoni bcantoni@salesforce.com
Co-authored-by: casey-crawford-cfa 91914995+casey-crawford-cfa@users.noreply.github.com

What's Changed

• fix: Incorrect size unit when logging fileUpload by @KulykDmytro in #1560
• docs: DatasourceItem and Endpoint docstrings by @jorwoods in #1556
• fix: Change GroupSets.get api for more consistency by @jorwoods in #1568
• fix: Virtual connection ConnectionItem attributes by @jorwoods in #1566
• fix: Remove vizHeight and vizWidth from ImageRequestOptions by @jorwoods in #1565
• feat: Adding incremental refresh option for workbook and datasource endpoints by @renoyjohnm in #1585
• feat: New JobItem code by @renoyjohnm in #1585

New Contributors

• @KulykDmytro made their first contribution in #1560

Full Changelog: v0.36...v0.37

Fixes a 400 Bad Request error when calling Refresh Datasource with 0.35

What's Changed

• feat: Workbook update Description by @LehmD in #1516

• feat: capture site content url from sign in by @jorwoods in #1524

• fix: datasource id on ConnectionItem by @jorwoods in #1538

• feat: support for thumbnail related options in workbook publish by @renoyjohnm in #1542

• feat: incremental refresh for extracts by @jacalata in #1545

• Fixing set default permissions for virtual connections by @TrimPeachu in #1535

• feat: publish datasource as replacement by @jacalata in #1546

• chore: Update versioneer by @jacalata in #1547

• docs: docstrings for custom_views by @jorwoods in #1540

• docs: webhook docstrings by @jorwoods in #1530

• docs: task docstrings by @jorwoods in #1527

• docs: docstrings for Pager and RequestOptions by @jorwoods in #1498

• docs: docstrings for group endpoint and item by @jorwoods in #1499

• docs: project docstrings by @jorwoods in #1505

• docs: docstrings for JobItem and Jobs endpoint by @jorwoods in #1529

• docs: docstrings on ConnectionItem and ConnectionCredentials by @jorwoods in #1526

• docs: flow docstrings by @jorwoods in #1532

• docs: docstrings for views by @jorwoods in #1523

New Contributors

• @LehmD made their first contribution in #1516

Full Changelog: v0.34...v0.35

What's Changed

• Draft: Make urllib3 dependency more flexible by @bcantoni in #1468
• chore(versions): Upgrade minimum python version by @jorwoods in #1465
• chore(typing): include samples in type checks by @jorwoods in #1455
• fix: queryset support for flowruns by @jorwoods in #1460
• #1464 - docs update for filtering on boolean values by @jacalata in #1471
• chore(versions): update remaining f-strings by @jorwoods in #1477
• #1475 Add 'description' to datasource sample code by @jacalata in #1475
• feat(exceptions): separate failed signin error by @jorwoods in #1478
• docs: add docstrings to auth objects and endpoints by @jorwoods in #1484
• Set FILESIZE_LIMIT_MB via environment variables by @Der-Henning in #1466
• added PulseMetricDefine cap by @AlbertWangXu in #1490
• Adding project permissions handling for databases, tables and virtual connections by @TrimPeachu in #1482
• docs: docstrings for Server and ServerInfo by @jorwoods in #1494
• refactor request_options, add language param by @jacalata in #1481
• docs: docstrings for user item and endpoint by @jorwoods in #1485
• ci: build on python 3.13 by @jorwoods in #1492
• docs: workbook docstrings by @jorwoods in #1488
• chore: type hint default permissions endpoints by @jorwoods in #1493
• fix: handle 0 item response in querysets by @jorwoods in #1501
• ci: cache dependencies for faster builds by @jorwoods in #1497
• Feature: export custom views #999 by @renoyjohnm in #1506
• chore: remove py2 holdover code by @jorwoods in #1496
• Update samples for Python 3.x compatibility by @bcantoni in #1479
• chore: support VizqlDataApiAccess capability by @jorwoods in #1504
• Remove sample code showing group name encoding by @jacalata in #1486
• Update requests library for CVE CVE-2024-35195 by @jacalata in #1507
• docs: docstrings for site item and endpoint by @jorwoods in #1495
• Bring development and master into sync by @jacalata in #1509
• Development to master branch merge by @renoyjohnm in #1511
• Revert "Development to master branch merge" by @renoyjohnm in #1513
• Revert "Bring development and master into sync" by @renoyjohnm in #1517
• Development to master in prep of release 0.34 by @bcantoni in #1519

New Contributors

• @Der-Henning made their first contribution in #1466
• @AlbertWangXu made their first contribution in #1490
• @renoyjohnm made their first contribution in #1506

Full Changelog: v0.33...v0.34

What's Changed

• Update contributors by @bcantoni in #1428
• Add support for all types of monthly repeating schedules by @bcantoni in #1462
• Add workbook and datasource name attributes to JobItem Model by @ivanB1975 in #1391
• chore: make auth endpoint imports absolute by @jorwoods in #1410
• chore: make imports for flows absolute by @jorwoods in #1411
• feat: group bulk edit by @jorwoods in #1413
• Add str() and repr() to DatabaseItem by @joelclark in #1432
• feat: add support for groupsets by @jorwoods in #1405
• feat: custom views dl pub by @jorwoods in #1434
• docs: add docstrings detailing the filter options by @jorwoods in #1435
• feat: tag everything by @jorwoods in #1422
• feat: get page and chunk size from env vars by @jorwoods in #1439
• feat: linked tasks by @jorwoods in #1424
• chore: typing decorators by @jorwoods in #1447
• fix: Pager typing by @jorwoods in #1449
• Add GroupSets by @jorwoods in #1444

New Contributors

• @ivanB1975 made their first contribution in #1391
• @joelclark made their first contribution in #1432

Full Changelog: v0.32...v0.33

What's Changed

• Bump urllib3 from 2.0.7 to 2.2.2 #1400
• Allow setting page_size in .all and .filter #1417
• Switch to absolute imports for favorites #1415
• Switch to absolute imports for datasource #1416
• Fix pop from empty list #1404
• Ignore known internal warnings on tests #1407
• Add support for changing project owner #1419
• Add type hints to auth models #1403
• Add typing to Pager #1390
• Remove blocks of code and arguments that have been deprecated #1380
• Add usage to views.get_by_id #1383
• Type hint QuerySet and QuerySetEndpoint #1399
• No implicit reexport #1394
• Allow combining PermissionRules #1381
• Add size to datasource item #1397
• Remove outdated dependencies #1398
• Don't lowercase OData server addresses #1396

What's Changed

• Remove deprecated cgi package and switch to email.message.Message #1346
• Allow viz height and width parameters #1348
• Add support for System schedule type #1350
• Add support for daily (24 hour) intervals for tasks #1355
• Update Actions to include Python 3.12 and reduce duplicate test runs #1356
• Add Data Acceleration and Data Freshness Policy support #1343
• Add create cloud flow task support #1371
• Pass parameters in request options #1372
• Improve robustness of Pager results #1370

What's Changed

• fix Unauthorized Error in 0.29 by @jacalata in https://github.com/tableau/server-client-python/pull/1345

Full Changelog: https://github.com/tableau/server-client-python/compare/v0.29...v0.30

What's Changed

• Various github action updates
• Bump urllib3 from 2.0.4 to 2.0.7 by @dependabot
• Fixed type annotation for workbook.refresh by @pes-magic in https://github.com/tableau/server-client-python/pull/1319
• Remove comment with fake password that was causing confusion by @bcantoni in https://github.com/tableau/server-client-python/pull/1323
• Add all missing RequestOptions fields by @jorwoods in https://github.com/tableau/server-client-python/pull/1307
• Jorwoods/1312 download hotfix by @jorwoods in https://github.com/tableau/server-client-python/pull/1330
• support for multiple intervals for hourly, daily, and monthly schedules by @a-torres-2 in https://github.com/tableau/server-client-python/pull/1328
• Jorwoods/tasks no schedule by @jorwoods in https://github.com/tableau/server-client-python/pull/1297
• Issue 1299 by @kykrueger in https://github.com/tableau/server-client-python/pull/1300
• Fix #1301 duplicate default permission requests by @gconklin in https://github.com/tableau/server-client-python/pull/1302

New Contributors

• @dependabot made their first contribution in https://github.com/tableau/server-client-python/pull/1287
• @pes-magic made their first contribution in https://github.com/tableau/server-client-python/pull/1319
• @kykrueger made their first contribution in https://github.com/tableau/server-client-python/pull/1300
• @gconklin made their first contribution in https://github.com/tableau/server-client-python/pull/1302

Full Changelog: https://github.com/tableau/server-client-python/compare/v0.28...v0.29

What's Changed

• make project nullable on datasource https://github.com/tableau/server-client-python/issues/1210
• add params to workbook publish method https://github.com/tableau/server-client-python/issues/1087
• add certification to publishing a datasource https://github.com/tableau/server-client-python/issues/1058
• add contentURL as a filter https://github.com/tableau/server-client-python/issues/456
• adding sample file for favorites, issue #737 by @narcolino-tableau in https://github.com/tableau/server-client-python/pull/1085
• logging updates, long running uploads now show incremental progress logs by @jacalata in https://github.com/tableau/server-client-python/pull/1222

• Implement custom view objects (https://github.com/tableau/server-client-python/pull/1195)
• Fix bug in update-datasources before 3.15 (https://github.com/tableau/server-client-python/pull/1203) (fixes https://github.com/tableau/server-client-python/issues/1072)
• catch exceptions from ServerInfo (https://github.com/tableau/server-client-python/pull/1204)
• add query-tagging attribute to connection (https://github.com/tableau/server-client-python/pull/1202) (add explanation for why it doesn't work on hyper)

What's Changed

• Add logic to retrieve Datarole and Metric permissions by @TrimPeachu in https://github.com/tableau/server-client-python/pull/1163
• Allow injection of sessions (https://github.com/tableau/server-client-python/pull/1111)
• show server info (https://github.com/tableau/server-client-python/pull/1118)
• Fix bug in exposing ExcelRequestOptions and test (https://github.com/tableau/server-client-python/pull/1123)
• Fix a few pylint errors (https://github.com/tableau/server-client-python/pull/1124)
• fix behavior when url has no protocol (https://github.com/tableau/server-client-python/pull/1125)
• add option to pass specific datasources to delete extracts (https://github.com/tableau/server-client-python/pull/1150)
• allow user agent to be set by caller (https://github.com/tableau/server-client-python/pull/1166)
• Fix issues with connections publishing workbooks (https://github.com/tableau/server-client-python/pull/1171)
• Allow download to file-like objects (https://github.com/tableau/server-client-python/pull/1172)
• Add updated_at to JobItem class (https://github.com/tableau/server-client-python/pull/1182)
• fix revision references where xml returned does not match docs (https://github.com/tableau/server-client-python/pull/1176)
• Do not create empty connections list (https://github.com/tableau/server-client-python/pull/1178)

Co-authored-by: Marwan Baghdad mrwanbaghdad76@gmail.com Co-authored-by: jorwoods jorwoods@users.noreply.github.com Co-authored-by: Brian Cantoni bcantoni@salesforce.com Co-authored-by: TrimPeachu 77048868+TrimPeachu@users.noreply.github.com Co-authored-by: Stu Tomlinson stu@nosnilmot.com Co-authored-by: Jeremy Harris jercharris89@gmail.com

Fixed automated publishing of packages to PyPI. No code changes since v0.23.1.

What's Changed

• Add custom session injection, Fix bug for http_options by @jacalata in https://github.com/tableau/server-client-python/pull/1119

Full Changelog: https://github.com/tableau/server-client-python/compare/v0.22...v0.23

Now also available on pypi! :)

• 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

Switched to using defused_xml for xml attack protection added linting and type hints improve experience with self-signed certificates/invalid ssl updated samples new item types: metrics, revisions for datasources and workbooks features: support adding flows to schedules, exporting workbooks to powerpoint fixes: delete extracts

TSC v0.17.0 (20 October 2021)

• Added support for accepting parameters for post request of the metadata api (#850)
• Fixed jobs.get_by_id(job_id) example & reference docs (#867, #868)
• Fixed handling for workbooks in personal spaces which do not have projectID or Name (#875)
• Updated links to Data Source Methods page in REST API docs (#879)
• Unified arguments of sample scripts (#889)
• Updated docs for - links to Datasource API (#879) , sample scripts (#892) & metadata query (#896)
• Added support for scheduling DataUpdate Jobs (#891)
• Exposed the fileuploads API endpoint (#894)
• Added a new sample & documentation for metadata API (#895, #896)
• Added support to the package for getting flow run status, as well as the ability to cancel flow runs. (#884)
• Added jobs.wait_for_job method (#903)
• Added description support for datasources item (#912)
• Dropped support for Python 3.5 (#911)

Full Changelog: https://github.com/tableau/server-client-python/compare/v0.16.0...v0.17.0

0.16.0 (15 July 2021)

• Documentation updates (#800, #818, #839, #842)
• Fixed data alert repr in subscription item (#821)
• Added support for Data Quality Warning (#836)
• Added support for renaming datasources (#843)
• Improved Datasource tests (#843)
• Updated catalog obfuscation field (#844)
• Fixed revision limit field in site_item.py file (#847)
• Added the Missing content permission field- LockedToProjectWithoutNested (#856)

0.15.0 (16 Feb 2021)

• Added support for python version 3.9 (#744)
• Added support for 'Get View by ID' (#750)
• Added docs and test data to MANIFEST.in file (#780)
• Added owner_id property to ProjectItem (#784)
• Added support for skipping connection check while publishing workbook (#791)
• Added support for 'Update Subscription' (#794)
• Added support for 'Get Groups for a User' (#799)
• Improved debug logging by including put/post request contents (#743)
• Improved local and active-directory group creation (#770)
• Improved 'Update Group' to match server requests/responses (#772)
• Improved SiteItem with new properties and functions (#777)
• Improved SubscriptionItem with new properties (#794)
• Improved the 'type' property of TaskItem to convert server response to enum (#796)
• Improved repository to use Github Actions for running tests/linter (#798)
• Fixed data_acceleration field causing error in workbook update payload (#741)

0.14.1 (9 Dec 2020)

• Fixed filter query issue for server version below 2020.1 (#745)
• Fixed large workbook/datasource publish issue (#757)

0.14.0 (9 Nov 2020)

• Added django-style filtering and sorting (#615)
• Added encoding tag-name before deleting (#687)
• Added 'Execute' Capability to permissions (#700)
• Added support for publishing workbook using file objects (#704)
• Added new fields to datasource_item (#705)
• Added all fields for users.get to get email and fullname (#713)
• Added support publishing datasource using file objects (#714)
• Improved request options by removing manual query param generation (#686)
• Improved publish_workbook sample to take in site (#694)
• Improved schedules.update() by removing constraint that required an interval (#711)
• Fixed site update/create not checking booleans properly (#723)

0.13 (1 Sept 2020)

• Added notes field to JobItem (#571)
• Added webpage_url field to WorkbookItem (#661)
• Added support for switching between sites (#655)
• Added support for querying favorites for a user (#656)
• Added support for Python 3.8 (#659)
• Added support for Data Alerts (#667)
• Added support for basic Extract operations - Create, Delete, en/re/decrypt for site (#672)
• Added support for creating and querying Active Directory groups (#674)
• Added support for asynchronously updating a group (#674)
• Improved handling of invalid dates (#529)
• Improved consistency of update_permission endpoints (#668)
• Documentation updates (#658, #669, #670, #673, #683)

0.12 (10 July 2020)

• Added hidden_views parameter to workbook publish method (#614)
• Added simple paging endpoint for GraphQL/Metadata API (#623)
• Added endpoints to Metadata API for retrieving backfill/eventing status (#626)
• Added maxage parameter to CSV and PDF export options (#635)
• Added support for querying, adding, and deleting favorites (#638)
• Added a sample for publishing datasources (#644)

0.11 (1 May 2020)

• Added more fields to Data Acceleration config (#588)
• Added OpenID as an auth setting enum (#610)
• Added support for Data Acceleration Reports (#596)
• Added support for view permissions (#526)
• Materialized views changed to Data Acceleration (#576)
• Improved consistency across workbook/datasource endpoints (#570)
• Fixed print error in update_connection.py (#602)
• Fixed log error in add user endpoint (#608)

0.10 (21 Feb 2020)

• Added a way to handle non-xml errors (#515)
• Added Webhooks endpoints for create, delete, get, list, and test (#523, #532)
• Added delete method in the tasks endpoint (#524)
• Added description attribute to WorkbookItem (#533)
• Added support for materializeViews as schedule and task types (#542)
• Added warnings to schedules (#550, #551)
• Added ability to update parent_id attribute of projects (#560, #567)
• Improved filename behavior for download endpoints (#517)
• Improved logging (#508)
• Fixed runtime error in permissions endpoint (#513)
• Fixed move_workbook_sites sample (#503)
• Fixed project permissions endpoints (#527)
• Fixed login.py sample to accept site name (#549)

0.9 (4 Oct 2019)

• Added Metadata API endpoints (#431)
• Added site settings for Data Catalog and Prep Conductor (#434)
• Added new fields to ViewItem (#331)
• Added support and samples for Tableau Server Personal Access Tokens (#465)
• Added Permissions endpoints (#429)
• Added tags to ViewItem (#470)
• Added Databases and Tables endpoints (#445)
• Added Flow endpoints (#494)
• Added ability to filter projects by topLevelProject attribute (#497)
• Improved server_info endpoint error handling (#439)
• Improved Pager to take in keyword arguments (#451)
• Fixed UUID serialization error while publishing workbook (#449)
• Fixed materalized views in request body for update_workbook (#461)

0.8.1 (17 July 2019)

• Fixed update_workbook endpoint (#454)

0.8 (8 Apr 2019)

• Added Max Age to download view image request (#360)
• Added Materialized Views (#378, #394, #396)
• Added PDF export of Workbook (#376)
• Added Support User Role (#392)
• Added Flow Subscriptions (#403)
• Updated Pager to handle un-paged results (#322)
• Fixed checked upload (#309, #319, #326, #329)
• Fixed embed_password field on publish (#416)

• Added cancel job (#299)
• Added Get background jobs (#298)
• Added Multi-credential support (#276)
• Added Update Groups (#279)
• Adding project_id to view (#285)
• Added ability to rename workbook using update workbook (#284)
• Added Sample for exporting full pdf using pdf page combining (#267)
• Added Sample for exporting data, images, and single view pdfs (#263)
• Added view filters to the populate request options (#260)
• Add Async publishing for workbook and datasource endpoints (#311)
• Fixed ability to update datasource server connection port (#283)
• Fixed next project handling (#267)
• Cleanup debugging output to strip out non-xml response
• Improved refresh sample for readability (#288)

• Expanded the enum for site roles

• Fixed #257 where refreshing extracts does not work due to a missing "self"

• Added support for add a datasource/workbook refresh to a schedule (#244)
• Added support for updating datasource connections (#253)
• Added Refresh Now for datasource and workbooks (#250)
• Fixed Typos in the docs (#251)

• Fix a critical issue caused by #224 that was the result of lack of test coverage (#226)

• Added revision settings to update site (#187)
• Added support for certified data sources (#189)
• Added support for include/exclude extract (#203)
• Added auto-paging for group users (#204)
• Added ability to add workbooks to a schedule (#206)
• Added the ability to create nested projects (#208)
• Fixed sort order when using pager (#192)
• Docs Updates and new samples (#196, #199, #200, #201)

• Fix #177 to remove left in debugging print

• Added API version annotations to endpoints (#125)
• Added New High Res Image Api Endpoint
• Added Tags to Datasources, Views
• Added Ability to run an Extract Refresh task (#159)
• Auto versioning enabled (#169)
• Download twbx/tdsx without the extract payload (#143, #144)
• New Sample to initialize a server (#95)
• Added ability to update connection information (#149)
• Added Ability to get a site by name (#153)
• Dates are now DateTime Objects (#102)
• Bugfixes (#162, #166)

• Return DateTime objects instead of strings (#102)
• UserItem now is compatible with Pager (#107, #109)
• Deprecated site in favor of site_id (#97)
• Improved handling of large downloads (#105, #111)
• Added support for oAuth when publishing (#117)
• Added Testing against Py36 (#122, #123)
• Added Version Checking to use highest supported REST api version (#100)
• Added Infrastructure for throwing error if trying to do something that is not supported by REST api version (#124)
• Various Code Cleanup
• Added Documentation (#98)
• Improved Test Infrastructure (#91)

• Added Initial Schedules Support (#48)
• Added Initial Create Group endpoint (#69)
• Added Connection Credentials for publishing datasources/workbooks (#80)
• Added Pager object for handling pagination results and sample (#72, #90)
• Added ServerInfo endpoint (#84)
• Deprecated site as a parameter to TableauAuth in favor of site_id
• Code Cleanup
• Bugfixes

• Initial Release to the world