Installation
Requirements
Python 3.10 or higher
Ollama running locally (or accessible via HTTP)
Install from PyPI
pip install yoker
Install from Source
git clone https://github.com/christophevg/yoker.git
cd yoker
# Create virtual environment (recommended)
pyenv virtualenv 3.10.13 yoker
echo "yoker" > .python-version
pyenv activate yoker
# Install with development dependencies
pip install -e ".[dev]"
Verify Installation
python -m yoker
You should see:
Yoker v0.1.0
========================================
Yoker v0.1.0 - Using model: llama3.2:latest
Type your message and press Enter. Press Ctrl+D to quit.
>
Development Setup
# Run tests
make test
# Type checking and linting
make check
# Build documentation
make docs
Dependencies
Core Dependencies
httpx>=0.25.0- HTTP client (async, streaming)ollama>=0.6.0- Ollama Python clientprompt_toolkit>=3.0.0- Interactive input with multiline supportrich>=14.0.0- Rich terminal outputstructlog>=23.0.0- Structured loggingpyyaml>=6.0- YAML parsing (for agent definitions)tomli>=2.0- TOML parsing (Python < 3.11)
Development Dependencies
pytest>=7.0.0- Testing frameworkpytest-cov>=4.0.0- Coverage reportingmypy>=1.0.0- Type checkingruff>=0.1.0- Linting and formattingsphinx>=7.0.0- Documentation
Next Steps
Quick Start - Get started with yoker