Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,33 @@ workflow that adapts to the conventions of all groups.
## Testing

`pip install tox` into your virtualenv, then `tox`.

## Local Setup Troubleshooting

If you run into issues setting up the project locally, here are some common fixes:

### Python version
- Use Python 3.10 (newer versions like 3.14 may cause dependency issues)

### pkg_resources error
If you see:
ModuleNotFoundError: No module named 'pkg_resources'

Run:
pip install "setuptools<82"

### Missing config file
If you see an error about config.dev.yaml:

Run:
cp config.default.yaml config.dev.yaml

### Database not initialized
If you see errors about missing tables:

- The database has not been initialized yet
- Check project setup steps or scripts to initialize the database

### General tip
- Always activate your virtual environment before running the app:
source venv/bin/activate