From 9c0dfc3c17cde062b85edc669e3487c5afc16ec5 Mon Sep 17 00:00:00 2001 From: Mendon Kissling <59585235+mendonk@users.noreply.github.com> Date: Tue, 3 Dec 2024 08:07:50 -0500 Subject: [PATCH] docs: add uv installation (#5011) * add-uv-option-to-installation-page * uv-readme * quickstart --- README.md | 8 ++++++- .../Get-Started/get-started-installation.md | 24 ++++++++++++++++--- .../Get-Started/get-started-quickstart.md | 4 ++-- 3 files changed, 30 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 44b85ae06..5211af7da 100644 --- a/README.md +++ b/README.md @@ -39,12 +39,18 @@ ## 📦 Quickstart -- **Install with pip** (Python 3.10 or greater): +- **Install with pip** (Python 3.10 to 3.12): ```shell pip install langflow ``` +- **Install with uv** (Python 3.10 to 3.12): + +```shell +uv pip install langflow +``` + - **Cloud:** DataStax Langflow is a hosted environment with zero setup. [Sign up for a free account.](https://astra.datastax.com/signup?type=langflow) - **Self-managed:** Run Langflow in your environment. [Install Langflow](https://docs.langflow.org/get-started-installation) to run a local Langflow server, and then use the [Quickstart](https://docs.langflow.org/get-started-quickstart) guide to create and execute a flow. - **Hugging Face:** [Clone the space using this link](https://huggingface.co/spaces/Langflow/Langflow?duplicate=true) to create a Langflow workspace. diff --git a/docs/docs/Get-Started/get-started-installation.md b/docs/docs/Get-Started/get-started-installation.md index 7195eaf12..35f5bc9c1 100644 --- a/docs/docs/Get-Started/get-started-installation.md +++ b/docs/docs/Get-Started/get-started-installation.md @@ -8,13 +8,13 @@ You can deploy Langflow either locally or as a hosted service with [**Datastax L ## Install Langflow locally -Install Langflow locally with [pip](https://pypi.org/project/pip/) or [pipx](https://pipx.pypa.io/stable/installation/). +Install Langflow locally with [pip](https://pypi.org/project/pip/), [uv](https://docs.astral.sh/uv/getting-started/installation/), or [pipx](https://pipx.pypa.io/stable/installation/). ### Prerequisites * [Python 3.10 to 3.12](https://www.python.org/downloads/release/python-3100/) installed -* [pip](https://pypi.org/project/pip/) or [pipx](https://pipx.pypa.io/stable/installation/) installed -* Before installing Langflow, we recommend creating a virtual environment to isolate your Python dependencies with [venv](https://docs.python.org/3/library/venv.html) or [conda](https://anaconda.org/anaconda/conda) +* [pip](https://pypi.org/project/pip/), [uv](https://docs.astral.sh/uv/getting-started/installation/), or [pipx](https://pipx.pypa.io/stable/installation/) installed +* Before installing Langflow, we recommend creating a virtual environment to isolate your Python dependencies with [venv](https://docs.python.org/3/library/venv.html), [uv](https://docs.astral.sh/uv/pip/environments), or [conda](https://anaconda.org/anaconda/conda) ### Install Langflow with pip or pipx @@ -24,6 +24,12 @@ Install Langflow with pip: python -m pip install langflow ``` +Install Langflow with uv: + +```bash +uv pip install langflow +``` + Install Langflow with pipx using the Python 3.10 executable: ```bash @@ -38,6 +44,12 @@ pipx install langflow --python python3.10 python -m langflow run ``` +To run Langflow with uv, enter the following command. + +```bash +uv run langflow run +``` + 2. Confirm that a local Langflow instance starts by visiting `http://127.0.0.1:7860` in a Chromium-based browser. Now that Langflow is running, follow the [Quickstart](/get-started-quickstart) to create your first flow. @@ -50,6 +62,12 @@ To upgrade Langflow to the latest version, use the pip upgrade command. python -m pip install langflow -U ``` +To upgrade Langflow to the latest version with uv, use the uv pip upgrade command. + +```bash +uv pip install langflow -U +``` + To install a specific version of the Langflow package, add the required version to the command. ```bash diff --git a/docs/docs/Get-Started/get-started-quickstart.md b/docs/docs/Get-Started/get-started-quickstart.md index 23db43286..08945bb37 100644 --- a/docs/docs/Get-Started/get-started-quickstart.md +++ b/docs/docs/Get-Started/get-started-quickstart.md @@ -10,8 +10,8 @@ slug: /get-started-quickstart * [Python 3.10 to 3.12](https://www.python.org/downloads/release/python-3100/) installed -* [pip](https://pypi.org/project/pip/) or [pipx](https://pipx.pypa.io/stable/installation/) installed -* Before installing Langflow, we recommend creating a virtual environment to isolate your Python dependencies with [venv](https://docs.python.org/3/library/venv.html) or [conda](https://anaconda.org/anaconda/conda) +* [pip](https://pypi.org/project/pip/), [uv](https://docs.astral.sh/uv/getting-started/installation/), or [pipx](https://pipx.pypa.io/stable/installation/) installed +* Before installing Langflow, we recommend creating a virtual environment to isolate your Python dependencies with [venv](https://docs.python.org/3/library/venv.html), [uv](https://docs.astral.sh/uv/pip/environments), or [conda](https://anaconda.org/anaconda/conda) ## Create the basic prompting flow