Skip to content

mi4uu/webOctoScribe

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

WebOctoScribe

logo

Web browser annotation tool. Navigate websites through a headless browser, record each action with explanations, and replay or export the annotated sessions.

tool usage better quality

tool usage gif prev

sessions better quality

sessions gif prev

Setup

Requires Python 3.12+ and uv.

uv sync
uv run playwright install chromium

Run

uv run uvicorn app.main:app --host 0.0.0.0 --port 3456 --reload

Then open http://localhost:3456.

Stack

  • FastAPI — web framework
  • MiniJinja — server-side templates
  • HTMX — frontend interactivity
  • Playwright — headless browser automation
  • uv — project management

Project Structure

app/
  main.py         # FastAPI routes
  browser.py      # Playwright browser automation
  store.py        # In-memory session store
  storage.py      # Disk persistence
  models.py       # Data models
  templating.py   # MiniJinja setup
templates/        # MiniJinja templates
  base.html
  home.html
  annotation.html
  sessions.html
  replay.html
  partials/       # HTMX fragment templates
static/           # CSS, JS, logo

How It Works

A Playwright headless browser session is launched for each annotation. Every action (click, type, scroll, etc.) is executed in the headless browser, a screenshot is captured, and the result is sent back to the frontend. The user annotates each step with an explanation of why the action was performed.

Frontend communication is handled with HTMX — the entire UI is server-driven, making HTMX a natural fit.

Sessions

Each annotation session is persisted to disk as a directory under sessions/, containing a session.json metadata file and numbered PNG screenshots. Sessions can be replayed as a slideshow, exported as JSON, or deleted.

About

Web browser annotation tool — navigate, record, replay, and export annotated browsing sessions

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors