Skip to content

Commit 60f0470

Browse files
authored
Update index.md (#481)
* 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 * Update index.md (#482) Removed test dependencies in anticipation of @t8y8 's package with those dependencies unwired.
1 parent 8c5a159 commit 60f0470

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

docs/index.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,14 @@ 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 and manually install the **requests** python library (and its dependencies).
56+
2) Download the [setup package](https://pypi.org/project/tableauserverclient/#files){:target="_blank"}.
57+
3) Run `pip install ./downloads/tableauserverclient-x.x.tar.gz`
58+
5159
## Get the samples
5260

5361
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 +74,15 @@ Run the following code to get a list of all the data sources on your installatio
6674
```py
6775
import tableauserverclient as TSC
6876

69-
tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD')
77+
tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD', 'SITENAME')
7078
server = TSC.Server('http://SERVER_URL')
7179

7280
with server.auth.sign_in(tableau_auth):
7381
all_datasources, pagination_item = server.datasources.get()
7482
print("\nThere are {} datasources on site: ".format(pagination_item.total_available))
7583
print([datasource.name for datasource in all_datasources])
7684
```
85+
86+
> `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/`.
87+
88+
>`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)