Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 0 additions & 1 deletion README

This file was deleted.

7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,14 @@ This repo contains Python source and example files for the Tableau Document API.

For more information, see the documentation:

<http://tableau.github.io/document-api-python>
<https://tableau.github.io/document-api-python>

Document API
---------------
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 :)

Features include:
- Support for 9.X, 10.X and 202x.x workbook and data source files
- Including TDSX and TWBX files
- Support for TWB, TWBX, TDE and TDSX files starting roughly back to Tableau 9.x
- Getting connection information from data sources and workbooks
- Server Name
- Username
Expand All @@ -28,6 +27,8 @@ Features include:
- Get all fields in a data source
- Get all fields in use by certain sheets in a workbook

For Hyper files, take a look a the [Tableau Hyper API](https://help.tableau.com/current/api/hyper_api/en-us/index.html).

We don't yet support creating files from scratch, adding extracts into workbooks or data sources, or updating field information

As of 2021, this SDK no longer supports Python 2.
2 changes: 1 addition & 1 deletion docs/_includes/header.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<ul class="nav navbar-nav">
<li><a href="{{ site.baseurl }}/docs/">Docs</a></li>
<li><a href="{{ site.baseurl }}/docs/api-ref">API Reference</a></li>
<li><a target="_blank" href="https://community.tableau.com/community/developers/content">Forum</a></li>
<li><a target="_blank" href="https://community.tableau.com/s/topic/0TO4T000000QF8eWAG/developers-apis">Forum</a></li>
<!-- <li><a href="{{ site.baseurl }}/news/">What's New?</a></li> -->
</ul>
<ul class="nav navbar-nav navbar-right">
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ a feature do not require the CLA.

## Issues and Feature Requests

To submit an issue/bug report, or to request a feature, please submit a [github issue](https://github.com/tableau/document-api-python/issues) to the repo.
To submit an issue/bug report, or to request a feature, please submit a [GitHub issue](https://github.com/tableau/document-api-python/issues) to the repo.

If you are submitting a bug report, please provide as much information as you can, including clear and concise repro steps, attaching any necessary
files to assist in the repro. **Be sure to scrub the files of any potentially sensitive information. Issues are public.**
Expand Down
39 changes: 19 additions & 20 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,32 +7,31 @@ layout: home
<p>This site will get you up and running with the Python version of the Tableau Document API. The Document API, including the samples and documentation, are all open source.</p>
<br />
<a class="btn btn-primary btn-lg" href="{{ site.baseurl }}/docs" role="button">Get Started</a>&nbsp;&nbsp;
<a class="btn btn-primary btn-lg" href="https://github.com/tableau/document-api-python/archive/v0.4.0.zip" role="button">Download</a>
<a class="btn btn-primary btn-lg" href="https://github.com/tableau/document-api-python/releases" role="button">Download</a>
</header>

# Document API Overview
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!

This repo contains Python source and example files for the Tableau Document API.

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.

Features include:

- Support for TWB, TWBX, TDE and TDSX files starting roughly back to Tableau 9.x
- Getting connection information from data sources and workbooks
- Server Name
- Username
- Database Name
- Authentication Type
- Connection Type
- Updating connection information in workbooks and data sources
- Server Name
- Username
- Database Name
- Getting Field information from data sources and workbooks
- Get all fields in a data source
- Get all fields in use by certain sheets in a workbook

>Features include:
>
>- Support for 9.X, and 10.X workbook and data source files
> - Including TDSX and TWBX files
>- Getting connection information from data sources and workbooks
> - Server Name
> - Username
> - Database Name
> - Authentication Type
> - Connection Type
>- Updating connection information in workbooks and data sources
> - Server Name
> - Username
> - Database Name
>- Getting Field information from data sources and workbooks
> - Get all fields in a data source
> - Get all fields in use by certain sheets in a workbook
For Hyper files, take a look a the [Tableau Hyper API](https://help.tableau.com/current/api/hyper_api/en-us/index.html).

We don't yet support creating files from scratch, adding extracts into workbooks or data sources, or updating field information.