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
+4-81Lines changed: 4 additions & 81 deletions
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,10 @@
4
4
5
5
This repo contains Python source and example files for the Tableau Document API. We're just getting started and have plans to expand what you find here. Help us by submitting feedback, issues, and pull requests!
6
6
7
+
For more information, see the documentation:
8
+
9
+
<tableau.github.io/document-api-python>
10
+
7
11
Document API
8
12
---------------
9
13
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 :)
@@ -26,84 +30,3 @@ Features include:
26
30
- Get all fields in use by certain sheets in a workbook
27
31
28
32
We don't yet support creating files from scratch, adding extracts into workbooks or data sources, or updating field information
29
-
30
-
31
-
###Getting Started
32
-
To use this SDK, you must have Python installed. You can use either 2.7.X or 3.3 and later.
33
-
34
-
#### Installing the latest stable version (preferred)
35
-
36
-
```text
37
-
pip install tableaudocumentapi
38
-
```
39
-
40
-
#### Installing From Source
41
-
42
-
Download the `.zip` file that contains the SDK. Unzip the file and then run the following command:
43
-
44
-
```text
45
-
pip install -e <directory containing setup.py>
46
-
```
47
-
48
-
#### Installing the Development Version from Git
49
-
50
-
*Only do this if you know you want the development version, no guarantee that we won't break APIs during development*
If you go this route, but want to switch back to the non-development version, you need to run the following command before installing the stable version:
57
-
58
-
```text
59
-
pip uninstall tableaudocumentapi
60
-
```
61
-
62
-
###Basics
63
-
The following example shows the basic syntax for using the Document API to update a workbook:
With Data Integration in Tableau 10, a data source can have multiple connections. To access the connections simply index them like you would datasources.
0 commit comments