Skip to content

publish-langchain.mdx

Latest commit

 

History

History
117 lines (85 loc) · 5.38 KB

publish-langchain.mdx

File metadata and controls

117 lines (85 loc) · 5.38 KB
title Publish an integration
sidebarTitle Publish

Make your integration available to the community.

:::python Do not submit integration PRs to the LangChain or Deep Agents repositories.

New integrations should be published as standalone PyPI packages under your own GitHub organization or account (e.g., langchain-yourservice), not as PRs to the langchain-ai/langchain repository.

The main repository only contains a small subset of first-party integrations (like OpenAI, Anthropic, and Ollama) maintained by the LangChain team.

Now that your package is implemented and tested, you can publish it and add documentation to make it discoverable by the community.

Publishing your package

This guide assumes you have already implemented your package and written tests for it. If you haven't, please refer to the [implementation guide](/oss/contributing/implement-langchain) and [testing guide](/oss/contributing/standard-tests-langchain).

For the purposes of this guide, we'll be using PyPI as the package registry. You may choose to publish to other registries if you prefer; instructions will vary.

Setup credentials

First, make sure you have a PyPI account:

Go to the [PyPI website](https://pypi.org/) and create an account 
        <Step title="Verify email">
            Verify your email address by clicking the link that PyPI emails to you
        </Step>

        <Step title="Enable 2FA">
            Go to your account settings and click "Generate Recovery Codes" to enable 2FA. To generate an API token, you **must** have 2FA enabled
        </Step>

        <Step title="Generate token">
            Go to your account settings and [generate a new API token](https://pypi.org/manage/account/token/)
        </Step>
    </Steps>
</Accordion>

Build and publish

<Card title="How to publish a package" icon="upload" href="https://docs.astral.sh/uv/guides/package/" arrow

Helpful guide from `uv` on how to build and publish a package to PyPI.

Adding documentation

To add documentation for your package to this site under the integrations tab, you will need to create the relevant documentation pages and open a PR in the LangChain docs repository.

Writing docs

Depending on the type of integration you have built, you will need to create different types of documentation pages. LangChain provides templates for different types of integrations to help you get started.

To reference existing documentation, you can look at the [list of integrations](/oss/integrations/providers/overview) and find similar ones to yours. 
To view a given documentation page in raw markdown, use the dropdown button next to "Copy page" on the top right of the page and select "View as Markdown".

Submit a PR to the docs repo

Make a fork of the LangChain docs repository (not the main langchain repo) under a personal GitHub account, and clone it locally. Create a new branch for your integration. Copy the template and modify it using your favorite markdown text editor. Make sure to refer to and follow the documentation guide when writing your documentation.

This PR is for **documentation only**. Your integration package itself should live in its own repository under your GitHub organization or account, published to PyPI as a standalone package. We may reject PRs or ask for modification if: - CI checks fail - Severe grammatical errors or typos are present - [Mintlify components](/oss/contributing/documentation#mintlify-components) are used incorrectly - Pages are missing a [frontmatter](/oss/contributing/documentation#page-structure) - [Localization](/oss/contributing/documentation#localization) is missing (where applicable) - [Code examples](/oss/contributing/documentation#in-code-documentation) do not run or have errors - [Quality standards](/oss/contributing/documentation#quality-standards) are not met

Please be patient as we handle a large volume of PRs. We will review your PR as soon as possible and provide feedback or merge it. Do not repeatedly tag maintainers about your PR.

Next steps

Congratulations! Your integration is now published and documented, making it available to the entire LangChain community.

Get in touch with the LangChain marketing team to explore co-marketing opportunities. :::

:::js TODO :::