Portia SDK Python 使用教程

1. 项目的目录结构及介绍

Portia SDK Python 是一个开源项目，其目录结构如下：

• .github/: 存放与 GitHub 相关的配置文件。
• tests/: 包含项目的单元测试代码。
• .env.example: 环境变量配置示例文件。
• .gitignore: 指定 Git 忽略的文件和目录。
• CODE_OF_CONDUCT.md: 项目的行为准则。
• CONTRIBUTING.md: 如何为项目贡献代码的指南。
• LICENSE: 项目的许可证文件。
• Logo_Portia_Stacked_Black.png: 项目标志图片。
• README.md: 项目的自述文件，介绍了项目的相关信息。
• example.py: 一个示例 Python 文件，展示如何使用 SDK。
• poetry.lock: 包管理工具 poetry 的锁定文件。
• pyproject.toml: 包管理工具 poetry 的配置文件。

每个文件和目录都有其特定的作用，确保项目的正常运行和开发。

2. 项目的启动文件介绍

项目的启动文件是 example.py。这个文件是一个简单的 Python 脚本，展示了如何使用 Portia SDK Python。以下是一个基本的启动示例：

from portia import Portia, default_config, example_tool_registry
from dotenv import load_dotenv

load_dotenv()

# 实例化 Portia 客户端，加载默认配置和示例工具
portia = Portia(config=default_config(), tools=example_tool_registry)

# 生成计划
plan = portia.plan('Which stock price grew faster in 2024, Amazon or Google?')
print(plan.model_dump_json(indent=2))

# 创建并执行计划
plan_run = portia.run_plan(plan)
print(plan_run.model_dump_json(indent=2))

这段代码首先加载环境变量，然后实例化 Portia 客户端，并使用默认配置和示例工具。之后，它生成一个计划，并打印出计划的 JSON 格式内容。最后，它创建并执行这个计划，并打印出执行状态的 JSON 格式内容。

3. 项目的配置文件介绍

项目的配置文件是 pyproject.toml。这个文件用于配置项目的包管理和依赖。以下是一个配置文件的示例：

[tool.poetry]
name = "portia-sdk-python"
version = "0.0.1"
description = "Portia Labs Python SDK for building agentic workflows."
authors = ["Portia AI <[e-mail]>"]

[tool.poetry.dependencies]
python = "^3.11"

这个配置文件指定了项目的名称、版本、描述和作者。它还定义了项目依赖的 Python 版本。

此外，项目可能使用环境变量文件 .env.example，它包含了项目运行所需的环境变量的示例。在本地开发时，你需要创建一个 .env 文件，并填入相应的环境变量值。

以上就是 Portia SDK Python 的基本使用教程，希望对你有所帮助。