Installation

Yosoi requires Python 3.10+, we strongly encourage using uv^△ for package management.

Install

uv add yosoi

pip install yosoi

poetry add yosoi

Install From Source

Clone the repository

git clone https://github.com/CascadingLabs/Yosoi

Navigate into the project directory
```
cd Yosoi
```
Install dependencies
```
uv sync
```
Optional: Install all dependency groups (dev, tests, etc.)
```
uv sync --all-groups
```

FAQs

Can I use pip instead of uv?

Yes. pip install yosoi works fine. The docs use uv because it is faster and handles virtual environments automatically, but there is no hard dependency on it.

Do I need all of these API keys?

No. One is enough. Yosoi supports 25+ providers — these five are just the most common. If multiple keys are present, set YOSOI_MODEL to specify which provider and model to use (e.g. groq:llama-3.3-70b-versatile).

Where should I put my .env file?

In your project root, next to pyproject.toml. Yosoi loads it automatically via python-dotenv^○. Do not commit it to version control.

What Python versions are supported?

Python 3.10 and above. Earlier versions are not supported due to use of modern type hint syntax.

References

△ uv. Astral. Python package and project manager. https://docs.astral.sh/uv/

○ python-dotenv. Saurabh Kumar. Read key-value pairs from a .env file and set them as environment variables. https://saurabh-kumar.com/python-dotenv/