Skip to content


Creating a virtual environment#

Using virtualenvwrapper#

mkvirtualenv woke

Using venv#

python3 -m venv env
source env/bin/activate


pip install -e ".[tests,dev]"

Pyright, our static type checker, is distributed through npm:

npm i -g pyright

Git hooks#

For Unix-like platforms, we provide up git hooks to help with development.

After cloning, execute.

chmod +x ./

Git hooks automatically run these commands when you commit:

  • pytest tests -m "not slow" when the WOKE_HOOKS_RUN_ALL_TESTS environment variable is not set (pytest tests is run otherwise)
  • pyright on Python files being committed
  • black on Python files being committed
  • isort on Python files being committed
  • mkdocs build --strict to make sure the documentation does not contain errors

Any unstaged changes and untracked files are stashed before running the git pre-commit hook. After the commit is made, the stashed changes are popped from the stash. If this leads to a merge conflict, the stashed changes are left at the top of the stash.