Local workspace

This is guide to setup as “source code install”. It is usefull to use with private patch by yourself.

When you will develop for bug fix or new features, please setup local repository by this document.

Overview

Todo

TBD

Development tools

This project uses these tools to management.

  • pre-commit (to manage git hooks)

  • uv >= 0.6.0 (to manage inner of python project)

Todo

Future plans

  • Lefthook (to manage git hooks instead of pre-commit)

  • go-task (project workflow excluded GitHub Actions)

Use mise (reccomended)

I use mise to manage tools outside of python. If you use mise, you can setup by only mise install.

Setup workspace

Note

After git clone.

  1. Set up hooks by pre-commit install.

  2. Set up virtualenv and deps by uv sync --extra test --extra doc.

    • If you want to develop for screenshot options, append --extra screenshot into uv sync and run uv run playwright install.

  3. Get Reveal.js assets by uv run tools/fetch_revealjs.py.

  4. Verify workspace by uv run pytest.

    • If it runs on Windows and it does not install libmagic, append --ignore=tests/test_extensions/test_screenshot.py into pytest command.

When you are developing for pull-request, Please keep green for pytest and pre-commit.