Added readme and chatterbox-server.py

This commit is contained in:
2026-06-07 09:16:26 +02:00
parent 6a6da2d066
commit 4a54bdab04
2 changed files with 250 additions and 7 deletions

View File

@@ -14,11 +14,19 @@ This project started as a [vibe-coded](https://en.wikipedia.org/wiki/Vibe_coding
### Setup [venv](https://docs.python.org/3/library/venv.html) for [python](https://www.python.org/)
Run [`setup-venv.sh`](./setup-venv.sh).
Run [`setup-venv.sh`](./setup-venv.sh).
> [!NOTE]
> The default location is a directory called `venv` that is created next to the script, but you can override it by using the environment variable `PYTHON_ENV` to point to a different location.
>
> ```console
> PYTHON_ENV='/some/path' ./setup-venv.s
> ```
### Environment
Variable | Purpose
------------------------|-------------------------
`HF_TOKEN_FILE` | Used to resolve a file for the [`HF_TOKEN`](https://huggingface.co/docs/hub/en/security-tokens) secret that is used to download models from [Hugging Face](https://huggingface.co/). If it is not set it defaults to `~/.secrets/hugging-face.token`.
`HF_HUB_CACHE` | Location for hugging face model cache, defaults to `~/.cache/huggingface/hub`.
> [!NOTE]
> The default location is a directory called `venv` that is created next to the script, but you can override it by using the environment variable `PYTHON_ENV` to point to a different location.
>
> ```console
> PYTHON_ENV='/some/path' ./setup-venv.s
> ```