發布您的套件

現在您的套件已實作並經過測試，您可以

1. 發布您的套件到 PyPi
2. 將您套件的文件新增至 LangChain Monorepo

發布您的套件到 PyPi

本指南假設您已實作您的套件並為其編寫測試。如果您尚未完成，請參考實作指南和測試指南。

請注意，發布套件到 PyPi 並非必要使用 Poetry，我們在本指南中端對端使用它僅為方便起見。您可以使用任何其他您偏好的方法發布您的套件。

首先，請確保您擁有 PyPi 帳戶並已使用 Poetry 登入

如何建立 PyPi Token

1. 前往 PyPi 網站並建立帳戶。
2. 點擊 PyPi 寄給您的連結以驗證您的電子郵件地址。
3. 前往您的帳戶設定並點擊「產生復原代碼」以啟用 2FA。若要產生 API Token，您目前必須啟用 2FA。
4. 前往您的帳戶設定並產生新的 API Token。

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 並 clone LangChain Monorepo
2. 在 docs/docs/integrations/providers/<您的套件名稱>.ipynb 建立「供應商頁面」
3. 在 docs/docs/integrations/<元件類型>/<您的套件名稱>.ipynb 建立「元件頁面」
4. 在 libs/packages.yml 中註冊您的套件
5. 提交僅包含這些變更的 PR 到 LangChain Monorepo

Fork 並 clone LangChain Monorepo

首先，fork LangChain Monorepo 到您的 GitHub 帳戶。

下一步，clone 儲存庫到您的本機

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 的根目錄快速建立供應商頁面

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

完成這些步驟後，您可以提交僅包含這些變更的 PR 到 LangChain Monorepo。

如果您有其他變更要請求，請在個別的 PR 中提交。