This document is designed to help develop new features locally for LINC | WebKNOSSOS
WebKNOSSOS CLI tool docs say that there is support between Python>=3.8,<=3.11. There were some intractable failures with 3.11, so 3.10 is used here
First, create a venv within 3.11 -- pyenv is a good tool to use if you are using 3.12 locally
Note: if you are on a Mac, you'll need to ensure you are emulating x86_64 arch locally -- a quick fix for this is to prefix
arch -x86_64 with each command -- e.g. arch -x86_64 pyenv exec python -m venv venv
# Set up local environment
pyenv local 3.11
pyenv exec python3 -m venv venv
source venv/bin/activate
# Install webknossos library
pip install webknossos
# Failure might occur with finding PIL import, thus possibly:
pip install Pillow
# At this point, you should be able to use the webknossos CLI --
webknossos helpYou'll need to set your authentication token as an env var WK_TOKEN: go to https://webknossos.lincbrain.org/auth/token
(or https://webknossos-staging.lincbrain.org/auth/token if you are on staging)
https://webknossos-staging.lincbrain.org/api/v5/user/annotations