Tableau API Lib 使用教程

Tableau API Lib 使用教程

tableau-api-lib An API library that allows developers to call on the methods listed in Tableau's REST API documentation. 项目地址: https://gitcode.com/gh_mirrors/ta/tableau-api-lib

1. 项目介绍

tableau-api-lib 是一个开源的 Python 库，它允许开发者调用 Tableau Server 的 REST API 方法。这个库提供了一个简洁的接口，使得开发者可以轻松地实现对 Tableau Server 的自动化管理，包括查询站点、工作簿、视图以及下载视图的 PDF 或截图等。

2. 项目快速启动

在开始使用 tableau-api-lib 之前，请确保您的环境中已安装 Python。

安装库

使用 pip 命令安装 tableau-api-lib：

pip install --upgrade tableau-api-lib

配置文件

创建一个配置文件，它应该包含连接到 Tableau Server 所需的所有信息。以下是一个配置文件的示例：

tableau_config = {
    'tableau_prod': {
        'server': 'https://<YOUR_PROD_SERVER>.com',
        'api_version': '<YOUR_PROD_API_VERSION>',
        'username': '<YOUR_PROD_USERNAME>',
        'password': '<YOUR_PROD_PASSWORD>',
        'site_name': '<YOUR_PROD_SITE_NAME>',
        'site_url': '<YOUR_PROD_SITE_URL>',
        'cache_buster': '',
        'temp_dir': ''
    }
}

将 <YOUR_PROD_SERVER>, <YOUR_PROD_API_VERSION>, <YOUR_PROD_USERNAME>, <YOUR_PROD_PASSWORD>, <YOUR_PROD_SITE_NAME>, 和 <YOUR_PROD_SITE_URL> 替换为实际的值。

初始化连接

使用配置文件初始化 TableauServerConnection：

from tableau_api_lib import TableauServerConnection

connection = TableauServerConnection(config_json=tableau_config, env='tableau_prod')

登录和查询站点

登录到 Tableau Server 并查询站点列表：

connection.sign_in()
print(connection.query_sites().json())
connection.sign_out()

3. 应用案例和最佳实践

查询工作簿

以下是一个查询特定站点中所有工作簿的示例：

site_id = 'your_site_id'
workbooks = connection.query_workbooks_on_site(site_id)
for workbook in workbooks.json()['workbooks']['workbook']:
    print(workbook['name'])

下载视图的 PDF

以下是一个下载特定工作簿中所有视图 PDF 的示例：

workbook_id = 'your_workbook_id'
views = connection.query_views_for_workbook(workbook_id)
for view in views.json()['views']['view']:
    pdf_url = connection.query_view_pdf(view['id'])
    # 这里可以使用 requests 或其他 HTTP 客户端下载 PDF

4. 典型生态项目

tableau-api-lib 作为 Tableau 自动化的工具，可以与其他开源项目结合使用，例如：

• 使用 requests 库来处理 HTTP 请求。
• 使用 pandas 库来处理和分析数据。
• 使用 pytest 来编写和执行测试用例。

结合这些工具，开发者可以构建一个强大的自动化流程，以提高 Tableau Server 的管理效率。

tableau-api-lib An API library that allows developers to call on the methods listed in Tableau's REST API documentation. 项目地址: https://gitcode.com/gh_mirrors/ta/tableau-api-lib