Getting Started
This project uses pyproject.toml instead of requirements.txt for dependency management.
Setup Instructions
1. Create a virtual environment (recommended)
python3 -m venv venv
source venv/bin/activate # On macOS/Linux
2. Install the project and dependencies
Install the project in editable mode (recommended for development):
pip install -e .
This will:
- Install all dependencies listed in
pyproject.toml(includingreachy-mini) - Install the package itself in editable mode, so code changes take effect immediately
- Register the app entry point so it appears in the Reachy Mini dashboard
3. Run the daemon
reachy-mini-daemon
4. Access the dashboard
Open your browser and go to:
http://0.0.0.0:8000/
Your app should appear in the "Applications" section of the dashboard.
5. Configure API Key (if needed)
If your app requires an API key (like OpenAI), you can set it in two ways:
Option 1: Environment variable (temporary)
export OPENAI_API_KEY=your-api-key-here
Option 2: .env file (recommended)
Create a .env file in the project root (same directory as pyproject.toml):
OPENAI_API_KEY=your-api-key-here
The app will automatically load the .env file when it starts. This is the recommended approach as it keeps your API key out of your shell history.
Alternative: Install dependencies only
If you only want to install dependencies without installing the package:
pip install reachy-mini
However, for a Reachy Mini app, installing with pip install -e . is recommended so the app is properly registered with the dashboard.
Troubleshooting
- App doesn't appear in dashboard: Make sure you installed with
pip install -e .and that the entry point inpyproject.tomlis correct. Restart the daemon after installing. - Import errors: Ensure you're using the same virtual environment where you installed the package
- Python version: This project requires Python >=3.10
- API key not found: Make sure your
.envfile is in the project root, or export the environment variable before starting the daemon