发布你的包
现在您的包已经实现并测试完毕,您可以:
- 将你的包发布到PyPi
- 将您的包的文档添加到LangChain Monorepo
将你的包发布到PyPi
本指南假设您已经实现了您的包并为其编写了测试。如果尚未完成,请参考实现指南和测试指南。
请注意,发布包到PyPi并不需要Poetry,我们在这个指南中从头到尾使用它只是为了方便。 欢迎您使用您喜欢的任何其他方法发布您的包。
首先,确保您有一个PyPi账户并且已经使用Poetry登录:
How to create a PyPi Token
- 前往PyPi网站并创建一个账户。
- 通过点击PyPi发送给您的链接来验证您的电子邮件地址。
- 转到您的账户设置并点击“生成恢复代码”以启用2FA。要生成API令牌,您必须当前已启用2FA。
- 转到您的账户设置并生成一个新的API令牌。
poetry config pypi-token.pypi <your-pypi-token>
接下来,构建你的包:
poetry build
最后,将你的包发布到PyPi:
poetry publish
你已经准备好了!你的包现在可以在PyPi上获取,并且可以通过pip install langchain-parrot-link
进行安装。
向LangChain Monorepo添加文档
要将您的包的文档添加到LangChain Monorepo,您需要:
- Fork 并克隆 LangChain Monorepo
- 在
docs/docs/integrations/providers/
创建一个“提供者页面”.ipynb - 在
docs/docs/integrations/
创建“组件页面”/ .ipynb - 在
libs/packages.yml
中注册你的包 - 向LangChain Monorepo提交一个仅包含这些更改的PR
Fork 并克隆 LangChain Monorepo
首先,将LangChain Monorepo fork到你的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 的根目录启动一个提供者页面:
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中提交。