Tableau REST API 示例项目的教程
1. 项目目录结构及介绍
此开源项目 tableau/rest-api-samples
的目录结构如下:
.
├── README.md # 项目简介和指南
├── auth # 认证相关的示例代码
│ └── authenticate.py # 登录认证示例
├── sheets # 工作表操作相关示例
│ ├── publish_workbook.py # 发布工作簿
│ └── update_worksheet.py # 更新工作表
└── tabs # 标签页操作相关示例
└── get_tab_data.py # 获取标签页数据
项目主要包含以下部分:
- auth: 提供了对Tableau服务器进行身份验证的示例脚本。
- sheets: 包含与在Tableau Server上发布和更新工作表有关的示例。
- tabs: 针对获取工作簿标签页数据的API调用示例。
每个子目录下的.py
文件是Python脚本,展示了如何使用Tableau REST API执行特定任务。
2. 项目启动文件介绍
项目本身不包含一个标准的启动文件,因为这是一个示例库。你需要根据你的需求选择合适的脚本运行。例如,如果你要进行用户认证,可以运行auth/authenticate.py
。每个脚本通常都会提供一些命令行参数来配置连接到Tableau Server的详细信息,例如服务器URL、用户名、密码等。要运行这些示例,首先确保安装了Python以及项目依赖(如requests
库),然后通过命令行指定所需的参数来执行相应的脚本。
3. 项目的配置文件介绍
这个项目没有预定义的配置文件。然而,为了适应不同的环境和用途,建议创建一个.env
或config.py
文件来存储敏感信息,如服务器URL、API版本号、用户名和密码。这样,你可以将这些值从源代码中分离出来,避免将其暴露在版本控制中。
例如,创建一个.env
文件,内容如下:
TABLEAU_SERVER=http://your-tableau-server.com
TABLEAU_API_VERSION=3.14
TABLEAU_USERNAME=<username>
TABLEAU_PASSWORD=<password>
然后,在Python脚本中,使用dotenv
库加载这些变量,以保持代码的安全性:
from dotenv import load_dotenv
import os
load_dotenv()
server = os.getenv('TABLEAU_SERVER')
version = os.getenv('TABLEAU_API_VERSION')
username = os.getenv('TABLEAU_USERNAME')
password = os.getenv('TABLEAU_PASSWORD')
# 使用这些变量进行API请求...
请确保在实际部署时,使用这种方法或其他安全手段管理敏感信息,而不是硬编码在代码中。