Skip to content

Commit 88e295c

Browse files
authored
Update index.md
Added *Install on an offline machine* in response to #365 Also added `SITENAME` and descriptive text to sign in of get started example per #355
1 parent 8c5a159 commit 88e295c

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

docs/index.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,20 @@ pip install git+https://github.com/tableau/server-client-python.git@development
4848
Note that the version from the development branch should not be used for production code. The methods and endpoints in the
4949
development version are subject to change at any time before the next stable release.
5050

51+
### Install on an offline machine
52+
53+
To install TSC onto a machine without internet connection, use the following steps:
54+
55+
1) Download the [setup package](https://pypi.org/project/tableauserverclient/#files){:target="_blank"}.
56+
2) Manually install the dependent Python libraries.
57+
58+
> **Note:** The way python dependencies are configured in the TSC set up package requires either for them to be preinstalled when installing TSC, or for network to be available to retrieve them. Offline installation currently requires manual installation of the following python libraries (and their dependencies) before intalling TSC:
59+
* pytest-runner
60+
* pytest
61+
* requests
62+
63+
3) Run `pip install ./downloads/tableauserverclient-x.x.tar.gz`
64+
5165
## Get the samples
5266

5367
The TSC samples are included in the `samples` directory of the TSC repository on Github. You can run the following command to clone the
@@ -66,11 +80,15 @@ Run the following code to get a list of all the data sources on your installatio
6680
```py
6781
import tableauserverclient as TSC
6882

69-
tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD')
83+
tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD', 'SITENAME')
7084
server = TSC.Server('http://SERVER_URL')
7185

7286
with server.auth.sign_in(tableau_auth):
7387
all_datasources, pagination_item = server.datasources.get()
7488
print("\nThere are {} datasources on site: ".format(pagination_item.total_available))
7589
print([datasource.name for datasource in all_datasources])
7690
```
91+
92+
> `SERVER_URL` is the URL of your Tableau server without subpaths. For local Tableau servers, an example would be: `https://www.MY_SERVER.com`. For Tableau Online, an example would be: `https://10ax.online.tableau.com/`.
93+
94+
>`SITENAME` is the subpath of your full site URL (also called `contentURL` in the REST API). `MYSITE` would be the site name of `https://10ax.online.tableau.com/MYSITE`. This parameter can be omitted when signing in to the Default site of a on premise Tableau server.

0 commit comments

Comments
 (0)