跳到主要内容
Open on GitHub

发布你的包

现在您的软件包已实现并经过测试，您可以

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

将您的软件包发布到 PyPi​

本指南假定您已实现您的软件包并为其编写了测试。如果您尚未完成此操作，请参阅实现指南和测试指南。

请注意，将软件包发布到 PyPi 并不需要 Poetry，我们在此指南中全程使用它只是为了方便。欢迎您使用任何其他偏好的方法发布您的软件包。

首先，确保您有一个 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. 派生并克隆 LangChain Monorepo
  2. 在 docs/docs/integrations/providers/<your-package-name>.ipynb 创建一个“提供者页面”
  3. 在 docs/docs/integrations/<component-type>/<your-package-name>.ipynb 创建“组件页面”
  4. 在 libs/packages.yml 中注册您的软件包
  5. 向 LangChain Monorepo 提交一个仅包含这些更改的 PR

派生并克隆 LangChain Monorepo​

首先，将LangChain Monorepo派生到您的 GitHub 账户。

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

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

您现在可以创建您的 PR 了！

为了更轻松地创建必要的文档页面，您可以使用 langchain-cli 引导它们。

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

pip install --upgrade langchain-cli

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

langchain-cli integration create-doc --help

让我们从 monorepo 的根目录引导一个提供者页面

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

以及一个聊天模型组件页面

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 中提交。