贡献

我们非常欢迎您为 Pydantic AI 做出贡献！

安装与设置

克隆你的 fork 并进入仓库目录

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

安装 uv (0.4.30 或更高版本)、pre-commit 和 deno

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

要安装 pre-commit，您可以运行以下命令

uv tool install pre-commit

对于 deno，您可以运行以下命令，或查看他们的文档以了解其他安装方法

curl -fsSL https://deno.land/install.sh | sh

安装 pydantic-ai、所有依赖项和 pre-commit 钩子

make install

运行测试等

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

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

make help

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

make

文档变更

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

uv run mkdocs serve

向 Pydantic AI 添加新模型的规则

为了避免给 Pydantic AI 的维护者带来过重的工作负担，我们无法接受所有模型的贡献，因此我们设定了以下规则，规定了我们何时会接受或不接受新模型。这有望减少失望和无效工作的情况。

• 要添加一个带有额外依赖的新模型，该依赖项需要连续 3 个月以上在 PyPI 上的月下载量超过 50 万
• 要添加一个内部使用其他模型逻辑且没有额外依赖的新模型，该模型的 GitHub 组织总星标数需要超过 2 万
• 对于任何其他仅需要自定义 URL 和 API 密钥的模型，我们很乐意添加一段包含链接和所用 URL 说明的描述
• 对于任何其他需要更多逻辑的模型，我们建议您发布自己的 Python 包 pydantic-ai-xxx，该包依赖于 pydantic-ai-slim，并实现一个继承自我们 Model ABC 的模型

如果您不确定是否要添加某个模型，请创建一个 issue。