Merge pull request #2391 from pipecat-ai/mb/readme-local-dev
Update README with local dev setup for contributors
This commit is contained in:
23
README.md
23
README.md
@@ -128,7 +128,7 @@ You can get started with Pipecat running on your local machine, then move your a
|
|||||||
2. Install development and testing dependencies:
|
2. Install development and testing dependencies:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
uv sync --group dev --all-extras --no-extra krisp
|
uv sync --group dev --all-extras --no-extra gstreamer --no-extra krisp --no-extra local
|
||||||
```
|
```
|
||||||
|
|
||||||
3. Install the git pre-commit hooks:
|
3. Install the git pre-commit hooks:
|
||||||
@@ -137,18 +137,25 @@ You can get started with Pipecat running on your local machine, then move your a
|
|||||||
uv run pre-commit install
|
uv run pre-commit install
|
||||||
```
|
```
|
||||||
|
|
||||||
### Python 3.13+ Note
|
### Python 3.13+ Compatibility
|
||||||
|
|
||||||
Some features require PyTorch (not yet available on Python 3.13+):
|
Some features require PyTorch, which doesn't yet support Python 3.13+. Install using:
|
||||||
|
|
||||||
- `ultravox`, `local-smart-turn`, `moondream`, `mlx-whisper`
|
|
||||||
|
|
||||||
**For full compatibility:** Use Python 3.12
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
uv python pin 3.12 && uv sync --group dev --all-extras --no-extra krisp
|
uv sync --group dev --all-extras \
|
||||||
|
--no-extra gstreamer \
|
||||||
|
--no-extra krisp \
|
||||||
|
--no-extra local \
|
||||||
|
--no-extra local-smart-turn \
|
||||||
|
--no-extra mlx-whisper \
|
||||||
|
--no-extra moondream \
|
||||||
|
--no-extra ultravox
|
||||||
```
|
```
|
||||||
|
|
||||||
|
> **Tip:** For full compatibility, use Python 3.12: `uv python pin 3.12`
|
||||||
|
|
||||||
|
> **Note**: Some extras (local, gstreamer) require system dependencies. See documentation if you encounter build errors.
|
||||||
|
|
||||||
### Running tests
|
### Running tests
|
||||||
|
|
||||||
To run all tests, from the root directory:
|
To run all tests, from the root directory:
|
||||||
|
|||||||
Reference in New Issue
Block a user