TableauDesktopPy

Tools for extracting metadata from Tableau Desktop workbook files. This package parses the underlying xml of a workbook to retrieve information on its style and data connections.

Installation

Install with pip:

pip install TableauDesktopPy

Usage

Provide a valid Tableau workbook file ('.twb' or '.twbx') to declare a Workbook object:

import TableauDesktopPy as tdp

my_workbook = tdp.Workbook("C:\Users\bpewyllie\test_workbook.twbx")

Then call any of the following attributes to retrieve workbook metadata:

Workbook.colors
Workbook.custom_sql
Workbook.excel
Workbook.fonts
Workbook.fields
Workbook.onedrive
Workbook.images
Workbook.shapes
... and more

Other metadata may be retrieved by calling the Workbook.xml attribute and parsing with an xml parser such as BeautifulSoup.
The module also provides methods for modifying a workbook's xml. Workbook.hide_field(), for example, hides an arbitrary field from the workbook's xml. To make the changes appear when opening the workbook in Tableau, first call the Workbook.save() method. Currently only saving as a .twb file is supported. To prevent confusion, it is best to run this method with the workbook closed.

Release notes

1.1.1 (3/19/2021)

Fix bug with some fields not showing up in fields attribute
Clean up some formatting with README files generated by generate_readme

1.1.0 (1/29/2021)

Ability to save workbooks to .twbx files
Change default fonts of workbooks

1.0.9 (1/22/2021)

Address README template not being accessible

1.0.8 (1/21/2021)

Include datasource in parenthetical in any field-related attribute to overcome duplicate-named fields from different datasources
Create method for building workbook README file
Create save method for overwriting workbooks
Create method for changing fonts
Fix some bugs with retrieving field names when parameters are present

To do

Create worksheet, datasource subclasses (long-term goal: allow more precise manipulation)
Create method for changing file paths of images and data files

bpewyllie/TableauDesktopPy