wehub-resource-sync
c56bef871b
Sync docs with Docusaurus / sync (push) Waiting to run
Tests / Check if changed (push) Waiting to run
Tests / format (push) Blocked by required conditions
Tests / check-imports (push) Blocked by required conditions
Tests / Unit / macos-latest (push) Blocked by required conditions
Tests / Unit / ubuntu-latest (push) Blocked by required conditions
Tests / Unit / windows-latest (push) Blocked by required conditions
Tests / mypy (push) Blocked by required conditions
Tests / Integration / ubuntu-latest (push) Blocked by required conditions
Tests / Integration / macos-latest (push) Blocked by required conditions
Tests / Integration / windows-latest (push) Blocked by required conditions
Tests / notify-slack-on-failure (push) Blocked by required conditions
Tests / Mark tests as completed (push) Blocked by required conditions
Docker image release / Build base image (push) Waiting to run
CodeQL / Analyze (python) (push) Has been cancelled
Update Platform Components Table / update (push) Has been cancelled
52 lines
1.6 KiB
Plaintext
52 lines
1.6 KiB
Plaintext
---
|
||
title: "Installation"
|
||
id: installation
|
||
slug: "/installation"
|
||
description: "See how to quickly install Haystack with pip, uv, or conda."
|
||
---
|
||
|
||
# Installation
|
||
|
||
See how to quickly install Haystack with pip, uv, or conda.
|
||
|
||
## Package Installation
|
||
|
||
Use [pip](https://github.com/pypa/pip) to install the [Haystack PyPI package](https://pypi.org/project/haystack-ai/):
|
||
|
||
```shell
|
||
pip install haystack-ai
|
||
```
|
||
|
||
Alternatively, you can use [uv](https://docs.astral.sh/uv/) to install Haystack:
|
||
|
||
```shell
|
||
uv pip install haystack-ai
|
||
```
|
||
|
||
Or add it as a dependency to your project:
|
||
|
||
```shell
|
||
uv add haystack-ai
|
||
```
|
||
|
||
You can also use [conda](https://docs.conda.io/projects/conda/en/stable/) to install the [Haystack conda package](https://anaconda.org/conda-forge/haystack-ai):
|
||
|
||
```shell
|
||
conda install conda-forge::haystack-ai
|
||
```
|
||
|
||
### Optional Dependencies
|
||
|
||
Some components in Haystack rely on additional optional dependencies.
|
||
To keep the installation lightweight, these are not included by default – only the essentials are installed.
|
||
If you use a feature that requires an optional dependency that hasn't been installed, Haystack will raise an error that instructs you to install missing dependencies, for example:
|
||
|
||
```shell
|
||
ImportError: "Haystack failed to import the optional dependency 'pypdf'. Run 'pip install pypdf'.
|
||
```
|
||
|
||
## Contributing to Haystack
|
||
|
||
If you would like to contribute to the Haystack, check our [Contributor Guidelines](https://github.com/deepset-ai/haystack/blob/main/CONTRIBUTING.md) first
|
||
and follow the instructions [here](https://github.com/deepset-ai/haystack/blob/main/CONTRIBUTING.md#setting-up-your-development-environment) to set up your development environment.
|