Skip to main content

Install custom dependencies

Langflow provides optional dependency groups and support for custom dependencies to extend Langflow functionality. This guide covers how to add dependencies for different Langflow installations, including Langflow Desktop and Langflow OSS.

The Langflow codebase uses three packages, each with its own pyproject.toml file:

  • The main package (langflow) is managed by the root level pyproject.toml, and it includes end-user features and main application code, such as Langchain and OpenAI. The main package depends on the base package.
  • The base package (langflow-base) is managed at src/backend/base/pyproject.toml, and it includes core infrastructure, such as the FastAPI web framework. The base package depends on the lfx package.
  • The lfx package is managed at src/lfx/pyproject.toml. LFX is a lightweight CLI tool for executing and serving Langflow flows. The lfx package does not provide optional dependency groups for end users.

Install custom dependencies in Langflow Desktop​

To add dependencies to Langflow Desktop, add an entry for the package to the application's requirements.txt file:

  • On macOS, the file is located at /Users/USER/.langflow/data/requirements.txt.
  • On Windows, the file is located at C:\Users\USER\AppData\Roaming\com.Langflow\data\requirements.txt.

Add each dependency to requirements.txt on its own line in the format DEPENDENCY==VERSION, such as matplotlib==3.10.0.

Restart Langflow Desktop to install the dependencies.

If you need to change or uninstall custom dependencies, edit the requirements.txt file, and then restart Langflow Desktop.

Install custom dependencies in Langflow OSS​

To install your own custom dependencies in your Langflow environment, add them with your package manager.

If you're working within a cloned Langflow repository, add dependencies with uv add because there is already a pyproject.toml file for uv to reference:


_10
uv add DEPENDENCY

Install optional dependency groups for langflow​

The langflow package (main) provides optional dependency groups that extend its functionality.

By default, installing langflow without any extras includes all dependencies listed in the [project.dependencies] section. Optional dependency groups are not installed by default and must be explicitly requested.

These optional dependencies are listed in the langflow pyproject.toml file under [project.optional-dependencies].

Install dependency groups using pip's [extras] syntax. For example, to install langflow with the postgresql dependency group, enter the following command:


_10
uv pip install "langflow[postgresql]"

To install multiple extras, use commas to separate each dependency group:


_10
uv pip install "langflow[postgresql,openai]"

Install optional dependency groups for langflow-base​

langflow-base is recommended when you want to deploy Langflow with specific dependencies only. It contains the same codebase as langflow, but langflow includes langflow-base as a dependency and adds many additional dependencies on top of it.

The langflow-base package provides its own optional dependency groups that are separate from those in the langflow package. The langflow-base package can be installed as a standalone package with these optional dependency groups.

By default, installing langflow-base without any extras includes all dependencies listed in the [project.dependencies] section. Optional dependency groups are not installed by default and must be explicitly requested. These optional dependency groups are listed in the langflow-base pyproject.toml file under [project.optional-dependencies].

Install langflow-base with optional dependency groups using pip's [extras] syntax. For example, to install langflow-base with the postgresql dependency group:


_10
uv pip install "langflow-base[postgresql]"

To install multiple extras, use commas to separate each dependency group:


_10
uv pip install "langflow-base[postgresql,openai]"

To install all optional dependencies for langflow-base, use the complete extra:


_10
uv pip install "langflow-base[complete]"

Use a virtual environment to test custom dependencies​

When testing locally, use a virtual environment to isolate your dependencies and prevent conflicts with other Python projects.

For example, if you want to experiment with a custom dependency like matplotlib with Langflow:


_10
# Create and activate a virtual environment
_10
uv venv YOUR_LANGFLOW_VENV
_10
source YOUR_LANGFLOW_VENV/bin/activate
_10
_10
# Install langflow and your additional dependency
_10
uv pip install langflow matplotlib

You can also install langflow-base with specific optional dependency groups in your virtual environment:


_10
# Install langflow-base with only the dependencies you need
_10
uv pip install "langflow-base[postgresql,openai]" matplotlib

If you're working within a cloned Langflow repository, add dependencies with uv add to reference the existing pyproject.toml files:


_10
uv add matplotlib

The uv add command automatically updates the uv.lock file in the appropriate location.

Add dependencies to the Langflow codebase​

When contributing to the Langflow codebase, you might need to add dependencies to Langflow.

To add a dependency to the main package, run uv add DEPENDENCY from the project root. For example:


_10
uv add matplotlib

Dependencies can be added to the main package as regular dependencies at [project.dependencies] or optional dependencies at [project.optional-dependencies].

To add a dependency to the base package, navigate to src/backend/base and run:


_10
uv add DEPENDENCY

To add a development dependency for testing, linting, or debugging, navigate to src/backend/base and run:


_10
cd src/backend/base && uv add --group dev DEPENDENCY

Dependencies can be added to the base package as regular dependencies at [project.dependencies], development dependencies at [dependency-groups.dev], or optional dependencies at [project.optional-dependencies].

You can optionally use make add instead of uv add:


_10
# Equivalent to: uv add matplotlib
_10
make add main="matplotlib"
_10
_10
# Equivalent to: cd src/backend/base && uv add --group dev matplotlib
_10
make add devel="matplotlib"
_10
_10
# Equivalent to: cd src/backend/base && uv add matplotlib
_10
make add base="matplotlib"

Alternatively, you can add these dependencies manually to the appropriate pyproject.toml file:


_10
[project]
_10
dependencies = [
_10
"matplotlib>=3.8.0"
_10
]

Or as an optional dependency in the main package:


_10
[project.optional-dependencies]
_10
plotting = [
_10
"matplotlib>=3.8.0",
_10
]

Or as a development dependency in the base package:


_10
[dependency-groups]
_10
dev = [
_10
"matplotlib>=3.8.0",
_10
]

See also​

Search