Skip to content

Update index.md #481

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dzucker-tab merged 2 commits into from
Aug 9, 2019
Merged

Update index.md #481

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
88e295c
Update index.md
dzucker-tab Aug 7, 2019
7a300c2
Update index.md (#482)
dzucker-tab Aug 8, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,14 @@ pip install git+https://github.com/tableau/server-client-python.git@development
Note that the version from the development branch should not be used for production code. The methods and endpoints in the
development version are subject to change at any time before the next stable release.

### Install on an offline machine

To install TSC onto a machine without internet connection, use the following steps:

1) Download and manually install the **requests** python library (and its dependencies).
2) Download the [setup package](https://pypi.org/project/tableauserverclient/#files){:target="_blank"}.
3) Run `pip install ./downloads/tableauserverclient-x.x.tar.gz`

## Get the samples

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

tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD')
tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD', 'SITENAME')
server = TSC.Server('http://SERVER_URL')

with server.auth.sign_in(tableau_auth):
all_datasources, pagination_item = server.datasources.get()
print("\nThere are {} datasources on site: ".format(pagination_item.total_available))
print([datasource.name for datasource in all_datasources])
```

> `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/`.

>`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.