Foundry Dev Tools 使用教程

1、项目介绍

Foundry Dev Tools 是一个用于与 Palantir Foundry 平台 API 进行交互的工具集。它由两部分组成：

• Transforms 实现：一个内部使用 CachedFoundryClient 的 Foundry transforms 包实现，允许你在本地机器上无缝运行 Palantir Foundry 代码仓库中的 transforms 代码。
• API 客户端：实现了多个 Foundry API 的客户端，如 Compass、Catalog 或 Foundry SQL Server。

2、项目快速启动

安装

你可以通过 pip 或 conda 安装 Foundry Dev Tools。

使用 pip 安装

pip install foundry-dev-tools

使用 conda 安装

conda install -c conda-forge foundry-dev-tools

快速使用示例

以下是一个简单的使用示例，展示了如何使用 Foundry Dev Tools 查询 Foundry SQL Server 中的数据。

from foundry_dev_tools import FoundryContext

# 初始化上下文，包含你的凭证和配置
ctx = FoundryContext()

# 查询 Foundry SQL Server
df = ctx.foundry_sql_server.query_foundry_sql("SELECT * FROM `/Global/Foundry Training and Resources/Example Data/Aviation Ontology/airlines`", branch='master')

# 输出查询结果的形状
print(df.shape)

3、应用案例和最佳实践

应用案例

Foundry Dev Tools 可以用于以下场景：

• 本地开发：在本地环境中开发和测试 Foundry transforms 代码，无需每次都上传到 Foundry 平台。
• 数据查询：通过 API 客户端直接查询 Foundry 平台中的数据，方便数据科学家进行数据分析。

最佳实践

• 使用现代开发工具：结合 Ruff、Mypy、Pylint、Black 等现代开发工具，提升代码质量和开发效率。
• 保持 Git 历史干净：避免意外或自动提交，确保 Git 历史记录的整洁。

4、典型生态项目

Foundry Dev Tools 可以与以下生态项目结合使用：

• Jupyter Notebook：用于数据探索和分析。
• VSCode 或 PyCharm：用于代码编辑和调试。
• Pre-commit Hooks：用于代码提交前的自动检查和格式化。

通过这些工具的结合，可以进一步提升开发效率和代码质量。