贡献

我们希望您能为PydanticAI做出贡献！

安装和设置

克隆你的分支并进入仓库目录

git clone git@github.com:<your username>/pydantic-ai.git
cd pydantic-ai

安装 uv （版本 0.4.30 或更高）和 pre-commit

我们在这里使用 pipx，其他选项请参见：

• uv 安装文档
• pre-commit 安装文档

要获取 pipx 本身，请参见 这些文档

pipx install uv pre-commit

安装 pydantic-ai、所有依赖项和预提交钩子

make install

运行测试等

我们使用 make 来管理大多数您需要运行的命令。

有关可用命令的详细信息，请运行：

make help

要运行代码格式化、代码检查、静态类型检查和生成覆盖率报告的测试，请运行：

make

文档变更

要在本地运行文档页面，请运行：

uv run mkdocs serve

将新模型添加到PydanticAI的规则

为了避免对PydanticAI维护者的工作负担过重，我们无法接受所有模型贡献，因此我们设定了以下规则，以便确定何时我们会接受新的模型，何时我们不会。希望这能减少失望和浪费工作的机会。

• 要添加一个具有额外依赖的新模型，该依赖在3个月或更长时间内需要在PyPI上每月稳定下载超过50万次
• 要添加一个新的模型，该模型内部使用另一个模型的逻辑并且没有额外的依赖，该模型的GitHub组织需要超过20k颗星
• 对于任何其他模型，只需提供一个自定义的URL和API密钥，我们很乐意添加一段包含链接的描述，以及关于使用该URL的说明
• 对于任何其他需要更多逻辑的模型，我们推荐您发布您自己的 Python 包 pydantic-ai-xxx，该包依赖于 pydantic-ai-slim 并实现一个继承自我们的 Model ABC 的模型

如果您不确定是否添加模型，请 创建一个问题。