Skip to content

Update samples list to match current file set #1480

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
merged 3 commits into from
Oct 10, 2024
Merged

Update samples list to match current file set #1480

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ec7f1c3
Update samples list to match current file set
bcantoni Sep 28, 2024
fe6216c
Remove workbook data acceleration; feature was removed in 2022
bcantoni Sep 30, 2024
0942468
Merge branch 'gh-pages' into bcantoni/update-sample-list
bcantoni Oct 8, 2024
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
2 changes: 1 addition & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ ENV/
# Rope project settings
.ropeproject


.vscode/

# macOS.gitignore from https://github.com/github/gitignore
*.DS_Store
Expand Down
9 changes: 6 additions & 3 deletions docs/samples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,15 +41,17 @@ You will see that you need to enter a file path for the workbook that you want t
The following list describes the samples available in the repository:

* `add_default_permission.py` Adds workbook default permissions for a given project.
* `create_extract_task.py` Creates extract tasks.
* `create_group.py` Creates a user group.
* `create_project.py` Creates a project in a site.
* `create_schedules.py` Creates schedules for extract refreshes and subscriptions.
* `download_view_image.py` Downloads an image of a specified view.
* `explore_datasource.py` Queries datasources, selects a datasource, populates connections for the datasource, then updates the datasource.
* `explore_favorites.py` Queries favorites and optionally add or delete favorites.
* `explore_site.py` Interacts with sites (create, delete, and so on).
* `explore_webhooks.py` Explores webhook functions supported by the Server API.
* `explore_workbook.py` Queries workbooks, selects a workbook, populates the connections and views for a workbook, then updates the workbook.
* `export.py` Exports a view as an image, PDF, or CSV.
* `export_wb.py` Exports a PDF containing all views in a workbook.
* `extracts.py` Interacts with extracts, including querying, deleting or creating.
* `filter_sort_groups.py` Demonstrates filtering and sorting user groups.
* `filter_sort_projects.py` Demonstrates filtering and sorting projects.
* `initialize_server.py` Sets up an existing server instance with site, workbooks and datasources.
Expand All @@ -65,9 +67,10 @@ The following list describes the samples available in the repository:
* `query_permissions.py` Queries permissions of a given resource.
* `refresh.py` Refreshes a datasource or workbook.
* `refresh_tasks.py` Lists and runs configured tasks on a server.
* `set_http_options.py` Demonstrates HTTP options for the server and specifically for downloading workbooks.
* `set_refresh_schedule.py` Sets the schedule to refresh a workbook or datasource.
* `smoke_test.py` Verifies that TSC is installed correctly and is able to run.
* `update_connection.py` Updates and embeds connection credentials of a datasource.
* `update_datasource_data.py` Updates the data within a published live-to-Hyper datasource.
* `update_workbook_data_freshness_policy.py` Updates workbook data freshness policy settings.

**Note**: For all of the samples, ensure that your Tableau Server user account has permission to access the resources. Also keep in mind that some example operations (like create group) are not allowed on Tableau Cloud.