You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+25-17Lines changed: 25 additions & 17 deletions
Original file line number
Diff line number
Diff line change
@@ -6,15 +6,26 @@ This repo contains Python source and example files for the Tableau Document API.
6
6
7
7
Document API
8
8
---------------
9
-
The Document API provides a supported way to programmatically make updates to Tableau workbook (`.twb`) and datasource (`.tds`) files. If you've been making changes to these file types by directly updating the XML--that is, by XML hacking--this SDK is for you :)
10
-
11
-
Currently only the following operations are supported:
12
-
13
-
- Modify database server
14
-
- Modify database name
15
-
- Modify database user
16
-
17
-
We don't yet support creating files from scratch. In addition, support for `.twbx` and `.tdsx` files is coming.
9
+
The Document API provides a supported way to programmatically make updates to Tableau workbook and data source files. If you've been making changes to these file types by directly updating the XML--that is, by XML hacking--this SDK is for you :)
10
+
11
+
Features include:
12
+
- Support for 8.X, 9.X, and 10.X workbook and data source files
13
+
- Including TDSX and TWBX files
14
+
- Getting connection information from data sources and workbooks
15
+
- Server Name
16
+
- Username
17
+
- Database Name
18
+
- Authentication Type
19
+
- Connection Type
20
+
- Updating connection information in workbooks and data sources
21
+
- Server Name
22
+
- Username
23
+
- Database Name
24
+
- Getting Field information from data sources and workbooks
25
+
- Get all fields in a data source
26
+
- Get all feilds in use by certain sheets in a workbook
27
+
28
+
We don't yet support creating files from scratch, adding extracts into workbooks or data sources, or updating field information
18
29
19
30
20
31
###Getting Started
@@ -34,9 +45,6 @@ Download the `.zip` file that contains the SDK. Unzip the file and then run the
34
45
pip install -e <directory containing setup.py>
35
46
```
36
47
37
-
We plan on putting the package in PyPi to make installation easier.
38
-
39
-
40
48
###Basics
41
49
The following example shows the basic syntax for using the Document API to update a workbook:
With Data Integration in Tableau 10, a datasource can have multiple connections. To access the connections simply index them like you would datasources
63
+
With Data Integration in Tableau 10, a data source can have multiple connections. To access the connections simply index them like you would datasources
56
64
57
65
```python
58
66
from tableaudocumentapi import Workbook
@@ -75,13 +83,13 @@ sourceWB.save()
75
83
**Notes**
76
84
77
85
- Import the `Workbook` object from the `tableaudocumentapi` module.
78
-
- To open a workbook, instantiate a `Workbook` object and pass the `.twb`file name in the constructor.
79
-
- The `Workbook` object exposes a `datasources`collection.
80
-
- Each datasource object has a `connection` object that supports a `server`, `dbname`, and `username` property.
86
+
- To open a workbook, instantiate a `Workbook` object and pass the file name as the first argument.
87
+
- The `Workbook` object exposes a list of `datasources`in the workbook
88
+
- Each data source object has a `connection` object that supports a `server`, `dbname`, and `username` property.
81
89
- Save changes to the workbook by calling the `save` or `save_as` method.
82
90
83
91
84
92
85
93
###Examples
86
94
87
-
The downloadable package contains an example named `replicateWorkbook.py` (in the folder `\Examples\Replicate Workbook`). This example reads an existing workbook and reads a .csv file that contains a list of servers, database names, and users. For each new user in the .csv file, the code copies the original workbook, updates the `server`, `dbname`, and `username` properties, and saves the workbook under a new name.
95
+
The downloadable package contains several example scripts that show more detailed usage of the Document API
0 commit comments