发布你的包

现在你的包已经实现并经过测试，你可以

1. 将你的包发布到 PyPi
2. 将你的包的文档添加到 LangChain Monorepo

将你的包发布到 PyPi

本指南假设你已经实现了你的包并为其编写了测试。如果你尚未完成这些操作，请参阅实现指南和测试指南。

请注意，Poetry 不是将包发布到 PyPi 的必需工具，我们为了方便起见在本指南中端到端地使用它。你也可以使用你喜欢的任何其他方法发布你的包。

首先，确保你拥有 PyPi 帐户并已使用 Poetry 登录

如何创建 PyPi 令牌

1. 转到 PyPi 网站并创建一个帐户。
2. 通过点击 PyPi 发送给你的电子邮件中的链接来验证你的电子邮件地址。
3. 转到你的帐户设置并单击“生成恢复代码”以启用 2FA。要生成 API 令牌，你必须当前启用 2FA。
4. 转到你的帐户设置并生成新的 API 令牌。

poetry config pypi-token.pypi <your-pypi-token>

下一步，构建你的包

poetry build

最后，将你的包发布到 PyPi

poetry publish

一切就绪！你的包现在已在 PyPi 上可用，可以使用 pip install langchain-parrot-link 安装。

将文档添加到 LangChain Monorepo

要将你的包的文档添加到 LangChain Monorepo，你需要

1. Fork 并克隆 LangChain Monorepo
2. 在 docs/docs/integrations/providers/<你的包名>.ipynb 创建“Provider Page”
3. 在 docs/docs/integrations/<组件类型>/<你的包名>.ipynb 创建“Component Pages”
4. 在 libs/packages.yml 中注册你的包
5. 提交一个 仅包含这些更改 的 PR 到 LangChain Monorepo

Fork 并克隆 LangChain Monorepo

首先，Fork LangChain Monorepo 到你的 GitHub 帐户。

接下来，将仓库克隆到你的本地机器

git clone https://github.com/<your-username>/langchain.git

你现在可以准备好制作你的 PR 了！

使用 langchain-cli 引导你的文档页面（推荐）

为了更容易创建必要的文档页面，你可以使用 langchain-cli 为你引导它们。

首先，安装最新版本的 langchain-cli 包

pip install --upgrade langchain-cli

要查看可用于引导你的文档页面的可用命令，请运行

langchain-cli integration create-doc --help

让我们从 monorepo 的根目录引导一个 provider 页面

langchain-cli integration create-doc \
    --component-type Provider \
    --destination-dir docs/docs/integrations/providers \
    --name parrot-link \
    --name-class ParrotLink

以及一个 chat 模型组件页面

langchain-cli integration create-doc \
    --component-type ChatModel \
    --destination-dir docs/docs/integrations/chat \
    --name parrot-link \
    --name-class ParrotLink

以及一个向量存储组件页面

langchain-cli integration create-doc \
    --component-type VectorStore \
    --destination-dir docs/docs/integrations/vectorstores \
    --name parrot-link \
    --name-class ParrotLink

这些命令将创建以下 3 个文件，你应该用有关你的包的信息填写它们

• docs/docs/integrations/providers/parrot_link.ipynb
• docs/docs/integrations/chat/parrot_link.ipynb
• docs/docs/integrations/vectorstores/parrot_link.ipynb

手动创建你的文档页面（如果你喜欢）

如果你喜欢手动创建文档页面，你可以创建上面列出的相同文件，并用有关你的包的信息填写它们。

如果需要，你可以在这里查看 CLI 用于创建这些文件的模板！

在 libs/packages.yml 中注册你的包

最后，将你的包添加到 LangChain Monorepo 中 libs/packages.yml 文件的末尾。

packages:
  - name: langchain-parrot-link
    repo: <your github handle>/<your repo>
    path: .

对于 path，如果你的包在仓库的根目录中，你可以使用 .，如果它在子目录中，则指定一个子目录（例如 libs/parrot-link）。

如果你遵循了包引导指南，那么你的路径是 .。

提交包含你的更改的 PR

完成这些步骤后，你可以向 LangChain Monorepo 提交一个 仅包含这些更改 的 PR。

如果你有其他更改要请求，请在单独的 PR 中提交它们。