Vibecode Readwise
track this build5 phases, 15 steps, beginner friendly0%KINDA · weekend project
The core loop is buildable, but a dependable replacement becomes a real weekend or multi-day project. For Readwise, import highlights from user-exported files, review them with spaced repetition, and export notes. The hard boundary is broad source integrations, sync, daily review polish, and knowledge-tool exports, plus capture polish, sync, and content partnerships.
the project pack5 files · written for this build, step by step
You are building a lean indie version of Readwise. Create the following project files first, then implement the application by following them. Keep the files updated as decisions change. Do not collapse this into a single README or prompt. ===== README.md ===== # Readwise · indie build Build a highlight importer with a review queue and source-linked exports. Estimated effort: **multi-day**. Work `BUILD_PLAN.md` top to bottom · every phase ends in a check that has to pass before the next one starts. ## Stack | Part | Choice | Why | | --- | --- | --- | | Runtime | Python 3.12+ and Flask | A small local HTTP application with readable server-side handlers and no JavaScript build pipeline. | | Storage | SQLite through Python sqlite3 | Local ownership with explicit transactions and a portable backup path. | | Interface | Jinja HTML templates, CSS and vanilla JavaScript | Implement the specified screens directly with labelled controls and progressive enhancement. | | Verification | Python unittest and browser acceptance fixtures | Check invariants and the actual user workflow before the next phase. | ## Before you start Have every one of these ready. The plan assumes them from step one. - [ ] **Python 3.12 or newer and a terminal** · Python is free; this local prototype requires no hosting subscription. - Why: The local backend, tests and storage use Python. - Get it: Install Python from python.org. Open a terminal in a new empty project folder. On Windows, use py -3 where this guide says python if python is not on PATH; on macOS/Linux use python3 if needed. Create .venv and activate it before installing packages. - Verify: python --version reports 3.12+ and python -c "import sqlite3" succeeds. - [ ] **A current desktop browser and text editor** · No paid service required for this local step. - Why: You need to view the local interface and edit generated project files. - Get it: Use an installed Chrome, Firefox or Edge browser. Open the empty project folder in your editor; open the terminal there, not in this catalog repository. - Verify: You can create a text file in the project folder and open browser developer tools. - [ ] **Readwise acceptance sample** · No paid service required for this local step. - Why: This fixture makes the first end-to-end check reproducible. - Get it: Create synthetic sample data before implementation: A CSV with two book highlights and a repeated row, one due today and one tomorrow. Save it under fixtures/ with the expected results in fixtures/README.md; use no real credentials or customer records. - Verify: The fixture files and expected outcomes exist and can be inspected without a vendor account. - [ ] **Confirm the bounded replacement** · No paid service required for this local step. - Why: The full commercial product is larger than this guide. - Get it: The deliverable is a highlight importer with a review queue and source-linked exports. Read every exclusion below. Indie mode runs locally; any public or shared use requires the product access and deployment gates first. - Verify: You can name the primary workflow and the vendor features this version deliberately leaves out. ## Quick start ```sh python -m venv .venv python -m pip install Flask Flask-WTF python-dotenv waitress tzdata python -m pip freeze > requirements.txt python -m flask --app app run --host 127.0.0.1 ``` Then copy `.env.example` to `.env` and fill in the values it documents. ## Honest limits This build deliberately does not replace: - A simple review scheduler is not a claim to reproduce Readwise internal algorithms. - This is a highlight importer with a review queue and source-linked exports; full Readwise feature parity, vendor hosting and support are not included. - broad source integrations, sync, daily review polish, and knowledge-tool exports - publisher bypasses - cross-device mobile capture - high-quality recommendation graph - licensed full-text feeds If one of those is essential to you, that is the reason to keep paying for Readwise, and the README should say so rather than pretend. ===== BRIEF.md ===== # Build brief · Readwise The one-shot brief this plan expands. `BUILD_PLAN.md` (or `MILESTONES.md`) is the same sequence broken into steps and checks; where the two disagree, the plan wins. Build me a highlight importer with a review queue and source-linked exports as a bounded replacement for Readwise. Build it in phases in the order below. Do not write the whole product in one pass. Finish the current phase, run its Done when checks, fix failures, then continue. Indie mode completes Phases 1-5. Phase 6 is required before shared or public deployment. ### Stack (fixed, do not substitute) - Runtime: Python 3.12+ and Flask. A small local HTTP application with readable server-side handlers and no JavaScript build pipeline. - Storage: SQLite through Python sqlite3. Local ownership with explicit transactions and a portable backup path. - Interface: Jinja HTML templates, CSS and vanilla JavaScript. Implement the specified screens directly with labelled controls and progressive enhancement. - Verification: Python unittest and browser acceptance fixtures. Check invariants and the actual user workflow before the next phase. ### Data model (create this before Phase 1) - sources(id,title,author,source_url) - highlights(id,source_id,text,location,import_hash) - reviews(id,highlight_id,at,rating) - schedules(highlight_id,due_date,interval_days) - notes(id,highlight_id,text) - Use stable ids and explicit relationships; add auxiliary tables named by the phases before those phases use them. - Acceptance fixture: A CSV with two book highlights and a repeated row, one due today and one tomorrow. ### Prerequisites and configuration - Python 3.12 or newer and a terminal: Install Python from python.org. Open a terminal in a new empty project folder. On Windows, use py -3 where this guide says python if python is not on PATH; on macOS/Linux use python3 if needed. Create .venv and activate it before installing packages. Verify: python --version reports 3.12+ and python -c "import sqlite3" succeeds. Cost: Python is free; this local prototype requires no hosting subscription. - A current desktop browser and text editor: Use an installed Chrome, Firefox or Edge browser. Open the empty project folder in your editor; open the terminal there, not in this catalog repository. Verify: You can create a text file in the project folder and open browser developer tools. Cost: No paid service required for this local step. - Readwise acceptance sample: Create synthetic sample data before implementation: A CSV with two book highlights and a repeated row, one due today and one tomorrow. Save it under fixtures/ with the expected results in fixtures/README.md; use no real credentials or customer records. Verify: The fixture files and expected outcomes exist and can be inspected without a vendor account. Cost: No paid service required for this local step. - Confirm the bounded replacement: The deliverable is a highlight importer with a review queue and source-linked exports. Read every exclusion below. Indie mode runs locally; any public or shared use requires the product access and deployment gates first. Verify: You can name the primary workflow and the vendor features this version deliberately leaves out. Cost: No paid service required for this local step. - Configuration: DATA_DIR, SECRET_KEY, APP_MODE, SITE_URL. Ship .env.example, replace placeholders and exclude secrets from git. ### Phase 1 · Local foundation and data contract Build: Create the runnable local foundation for a highlight importer with a review queue and source-linked exports, including the real schema and acceptance fixture. - Run the venv command first, then stop and activate it before running the remaining commands. Use your OS instructions: Windows .venv\Scripts\activate.bat in cmd, or .venv\Scripts\Activate.ps1 in PowerShell; macOS/Linux source .venv/bin/activate. Then install the listed packages. Create app.py exposing app, load .env with python-dotenv, and add a /healthz route. Freeze tested dependency versions to requirements.txt. Create .env manually from .env.example; replace SECRET_KEY before launch. Commands, after creating the named files: `python -m venv .venv`; `python -m pip install Flask Flask-WTF python-dotenv waitress tzdata`; `python -m pip freeze > requirements.txt`; `python -m flask --app app run --host 127.0.0.1`. - For database-backed state create schema.sql and db.py using this model: sources(id,title,author,source_url); highlights(id,source_id,text,location,import_hash); reviews(id,highlight_id,at,rating); schedules(highlight_id,due_date,interval_days); notes(id,highlight_id,text). Add the auxiliary relationships explicitly used in later phases; use stable ids, foreign keys, parameterized values and transactions. For canonical files use atomic replacement and hashes instead. Implement python manage.py init and python manage.py seed to create only synthetic data: A CSV with two book highlights and a repeated row, one due today and one tomorrow. Re-running init must not erase data. Commands, after creating the named files: `python manage.py init`; `python manage.py seed`. - Install Flask-WTF CSRF protection for forms and same-origin fetches, validate Host and Origin against SITE_URL, bound inputs and escape output. Deliberately public intake endpoints get bounded validation and rate limits; signed provider webhooks use signature checks instead of browser CSRF tokens. All other admin routes stay local until product authentication exists. When a later phase tests viewer/member permissions, implement the users, hashed passwords, expiring server sessions and role checks in this foundation first; product mode must never use a fabricated identity from request input. Add error, empty, keyboard-focus and retry states now. - Trap: The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation. Done when: The documented start command serves /healthz and the initial screen at http://127.0.0.1:5000. Restarting preserves the seeded records or canonical files; running init again deletes nothing. A cross-origin state-changing request to an admin route is refused. Do not build yet: Do not start import without duplicates until these checks pass. ### Phase 2 · Import without duplicates Build: Import without duplicates for Readwise: Preview CSV mapping for title, author, highlight and location; retain source provenance per highlight. - Preview CSV mapping for title, author, highlight and location; retain source provenance per highlight. - Generate an import identity from source, location and normalized text and show repeated rows before commit. - Use A CSV with two book highlights and a repeated row, one due today and one tomorrow. Check: Importing the fixture twice leaves two highlights. Then check: A changed annotation is not discarded as a duplicate highlight. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Commands, after creating the named files: `python -m unittest discover -s test`. - Trap: Source title alone cannot uniquely identify a book edition or web source. Done when: Importing the fixture twice leaves two highlights. A changed annotation is not discarded as a duplicate highlight. Do not build yet: Do not start deterministic review until these checks pass. ### Phase 3 · Deterministic review Build: Deterministic review for Readwise: Build a due-today queue with again/good responses; define fixed interval rules in code and store every review event. - Build a due-today queue with again/good responses; define fixed interval rules in code and store every review event. - Use the user-selected local date for scheduling and show the next due date before saving a response. - Use A CSV with two book highlights and a repeated row, one due today and one tomorrow. Check: Again schedules tomorrow and Good doubles the previous interval according to the documented rule. Then check: Refreshing after answering does not submit a second review. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Commands, after creating the named files: `python -m unittest discover -s test`. - Trap: A simple review scheduler is not a claim to reproduce Readwise internal algorithms. Done when: Again schedules tomorrow and Good doubles the previous interval according to the documented rule. Refreshing after answering does not submit a second review. Do not build yet: Do not start annotations and notes export until these checks pass. ### Phase 4 · Annotations and notes export Build: Annotations and notes export for Readwise: Add personal notes and source filtering; preserve quoted text separately from commentary. - Add personal notes and source filtering; preserve quoted text separately from commentary. - Export Markdown grouped by source with locations and a JSON bundle containing schedules and history. - Use A CSV with two book highlights and a repeated row, one due today and one tomorrow. Check: The Markdown export distinguishes the quote from the user note. Then check: Importing a backup restores the same due queue and review count. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Commands, after creating the named files: `python -m unittest discover -s test`. - Trap: Do not promise Kindle or publisher integrations; use user-exported files first. Done when: The Markdown export distinguishes the quote from the user note. Importing a backup restores the same due queue and review count. Do not build yet: Do not start portable delivery and clean-start proof until these checks pass. ### Phase 5 · Portable delivery and clean-start proof Build: Finish the Readwise replacement with a documented first-run path and a recoverable export. - Document prerequisites, every configuration variable, data locations and the three domain workflows: Import without duplicates; Deterministic review; Annotations and notes export. Include the exclusions, actual costs and source check date 2026-09-05. Commands shown earlier that reference project files are files the builder must implement before running them. - Use sqlite3.Connection.backup for the database in DATA_DIR and pause writers while taking the matching attachment snapshot. Keep schema version, hashes and a manifest for readwise. Restore into a separate empty directory or isolated deployment, with all outbound actions and schedules disabled. Recreate this proof: A CSV with two book highlights and a repeated row, one due today and one tomorrow. Compare ids/counts and open the result before recording the restore date. Never test a restore over the only live copy. - Use a new folder and only README instructions to reach the fixture outcome. Install from requirements.txt, initialize storage, run the tests and exercise the UI at 375px and 1280px; use keyboard-only controls and inspect browser errors. Record exactly what passed; do not mark unrun checks complete. Commands, after creating the named files: `python -m pip install -r requirements.txt`; `python -m unittest discover -s test`. - Trap: Export without an import or restore rehearsal is not verified portability. Done when: A new folder reaches the documented fixture outcome using only README instructions. A backup restored in isolation preserves the proof data and can be opened. Do not build yet: Do not start operate and share with access controls until these checks pass. ### Phase 6 · Operate and share with access controls (product-builder only) Build: Product-builder only: make a highlight importer with a review queue and source-linked exports operable for its stated audience before allowing remote access. - Add owner/member/viewer authorization as appropriate, password hashes through Werkzeug, expiring server-side sessions, CSRF and login rate limits. Add users, sessions and audit schema migrations plus an owner-init command prompting securely for its password. Enforce ownership on every private read/write/download and fail closed when product setup is incomplete. Existing learner or admin identities must use this same boundary. - Serve app:app with Waitress on loopback behind Caddy HTTPS. Configure trusted proxy headers narrowly, Secure/HttpOnly/SameSite cookies, upload limits, request ids and structured logs without private content. Run background jobs as a separate supervised process when the domain workflow requires them. Commands, after creating the named files: `waitress-serve --listen=127.0.0.1:5000 app:app`. - Add a scheduled encrypted off-host backup using this procedure: Use sqlite3.Connection.backup for the database in DATA_DIR and pause writers while taking the matching attachment snapshot. Keep schema version, hashes and a manifest for readwise. Monitor health, disk space, failed jobs and backup age. Stop the service to test an alert; rehearse recovery with outbound effects disabled and record recovery time. Rotate any exposed credentials and require reconciliation before resuming queues. - Trap: Product mode is additional engineering, not a switch that makes a local prototype production-ready. Done when: An unauthenticated visitor cannot read private records, download private files or mutate the admin surface. A viewer cannot mutate data by making a direct request, and guessed ids cannot cross ownership boundaries. Stopping the service triggers the configured alert and the latest off-host backup restores the fixture in isolation. Do not build yet: Do not add new providers or vendor-scale features until the release gates are recorded. ### Out of scope (and why) - A simple review scheduler is not a claim to reproduce Readwise internal algorithms. - This is a highlight importer with a review queue and source-linked exports; full Readwise feature parity, vendor hosting and support are not included. - broad source integrations, sync, daily review polish, and knowledge-tool exports: retain the paid product if this capability is essential; it is outside this bounded build. - publisher bypasses: retain the paid product if this capability is essential; it is outside this bounded build. - cross-device mobile capture: retain the paid product if this capability is essential; it is outside this bounded build. - high-quality recommendation graph: retain the paid product if this capability is essential; it is outside this bounded build. - licensed full-text feeds: retain the paid product if this capability is essential; it is outside this bounded build. ### README must contain - Exact install, configure, initialize, start, test and recovery commands for a clean folder. - The schema, fixture, acceptance results, private data locations and export format. - Every prerequisite and secret source, actual running costs and deliberately excluded capabilities. - An honest distinction between tests actually run and checks still awaiting real credentials or deployment. - Dependency documentation reviewed 2026-09-05: https://flask.palletsprojects.com/en/stable/installation/ ; https://docs.python.org/3/library/sqlite3.html ; https://flask-wtf.readthedocs.io/en/1.2.x/csrf/ ; https://docs.pylonsproject.org/projects/waitress/en/stable/usage.html. Recheck before upgrading; freeze the versions actually tested. ===== AGENTS.md ===== # Agent instructions · Readwise indie build - Read `README.md` and `BUILD_PLAN.md` before writing code. The stack is fixed: Python 3.12+ and Flask, SQLite through Python sqlite3, Jinja HTML templates, CSS and vanilla JavaScript, Python unittest and browser acceptance fixtures. Do not substitute. - Work one phase at a time, in order. Do not start a phase until every "Done when" item of the previous one passes. - Prefer the fewest moving parts that satisfy the step. No frameworks, services or dependencies the plan does not name. - Secrets live in `.env`, never in source or logs. Keep `.env.example` current when a variable is introduced. - Do not invent cryptography, security guarantees, APIs or compliance claims. - Add a focused test for every destructive, security-sensitive or data-loss path the plan names. - Run the project checks before declaring a phase complete, and record any deliberate shortcut in the README under "Tradeoffs". ## Known traps - The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation. - Source title alone cannot uniquely identify a book edition or web source. - A simple review scheduler is not a claim to reproduce Readwise internal algorithms. - Do not promise Kindle or publisher integrations; use user-exported files first. - Export without an import or restore rehearsal is not verified portability. ===== BUILD_PLAN.md ===== # Build plan · Readwise Build a highlight importer with a review queue and source-linked exports. Phases are in dependency order. Each ends in a "Done when" list; treat an unticked item as a blocker, not a note. ## Phase 1 · Local foundation and data contract Create the runnable local foundation for a highlight importer with a review queue and source-linked exports, including the real schema and acceptance fixture. ### Steps 1. Create and start the local application Run the venv command first, then stop and activate it before running the remaining commands. Use your OS instructions: Windows .venv\Scripts\activate.bat in cmd, or .venv\Scripts\Activate.ps1 in PowerShell; macOS/Linux source .venv/bin/activate. Then install the listed packages. Create app.py exposing app, load .env with python-dotenv, and add a /healthz route. Freeze tested dependency versions to requirements.txt. Create .env manually from .env.example; replace SECRET_KEY before launch. Files: `app.py`, `requirements.txt`, `.env.example`, `.gitignore` ```sh python -m venv .venv python -m pip install Flask Flask-WTF python-dotenv waitress tzdata python -m pip freeze > requirements.txt python -m flask --app app run --host 127.0.0.1 ``` 2. Implement storage and seed the named fixture For database-backed state create schema.sql and db.py using this model: sources(id,title,author,source_url); highlights(id,source_id,text,location,import_hash); reviews(id,highlight_id,at,rating); schedules(highlight_id,due_date,interval_days); notes(id,highlight_id,text). Add the auxiliary relationships explicitly used in later phases; use stable ids, foreign keys, parameterized values and transactions. For canonical files use atomic replacement and hashes instead. Implement python manage.py init and python manage.py seed to create only synthetic data: A CSV with two book highlights and a repeated row, one due today and one tomorrow. Re-running init must not erase data. Files: `schema.sql`, `db.py`, `manage.py`, `fixtures/README.md` ```sh python manage.py init python manage.py seed ``` 3. Protect the local request boundary Install Flask-WTF CSRF protection for forms and same-origin fetches, validate Host and Origin against SITE_URL, bound inputs and escape output. Deliberately public intake endpoints get bounded validation and rate limits; signed provider webhooks use signature checks instead of browser CSRF tokens. All other admin routes stay local until product authentication exists. When a later phase tests viewer/member permissions, implement the users, hashed passwords, expiring server sessions and role checks in this foundation first; product mode must never use a fabricated identity from request input. Add error, empty, keyboard-focus and retry states now. Files: `app.py`, `templates/base.html`, `test/test_foundation.py` ### Done when - [ ] The documented start command serves /healthz and the initial screen at http://127.0.0.1:5000. - [ ] Restarting preserves the seeded records or canonical files; running init again deletes nothing. - [ ] A cross-origin state-changing request to an admin route is refused. ### Watch out - The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation. ## Phase 2 · Import without duplicates Import without duplicates for Readwise: Preview CSV mapping for title, author, highlight and location; retain source provenance per highlight. ### Steps 1. Preview CSV mapping for title, author, highlight and location; retain source provenance per highlight. Preview CSV mapping for title, author, highlight and location; retain source provenance per highlight. Files: `features/import_without_duplicates.py`, `templates/import_without_duplicates.html` 2. Generate an import identity from source, location and normalized text and show repeated rows before commit. Generate an import identity from source, location and normalized text and show repeated rows before commit. Files: `features/import_without_duplicates.py` 3. Exercise the acceptance fixture Use A CSV with two book highlights and a repeated row, one due today and one tomorrow. Check: Importing the fixture twice leaves two highlights. Then check: A changed annotation is not discarded as a duplicate highlight. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Files: `test/test_import_without_duplicates.py` ```sh python -m unittest discover -s test ``` ### Done when - [ ] Importing the fixture twice leaves two highlights. - [ ] A changed annotation is not discarded as a duplicate highlight. ### Watch out - Source title alone cannot uniquely identify a book edition or web source. ## Phase 3 · Deterministic review Deterministic review for Readwise: Build a due-today queue with again/good responses; define fixed interval rules in code and store every review event. ### Steps 1. Build a due-today queue with again/good responses; define fixed interval rules in code and store every review event. Build a due-today queue with again/good responses; define fixed interval rules in code and store every review event. Files: `features/deterministic_review.py`, `templates/deterministic_review.html` 2. Use the user-selected local date for scheduling and show the next due date before saving a response. Use the user-selected local date for scheduling and show the next due date before saving a response. Files: `features/deterministic_review.py` 3. Exercise the acceptance fixture Use A CSV with two book highlights and a repeated row, one due today and one tomorrow. Check: Again schedules tomorrow and Good doubles the previous interval according to the documented rule. Then check: Refreshing after answering does not submit a second review. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Files: `test/test_deterministic_review.py` ```sh python -m unittest discover -s test ``` ### Done when - [ ] Again schedules tomorrow and Good doubles the previous interval according to the documented rule. - [ ] Refreshing after answering does not submit a second review. ### Watch out - A simple review scheduler is not a claim to reproduce Readwise internal algorithms. ## Phase 4 · Annotations and notes export Annotations and notes export for Readwise: Add personal notes and source filtering; preserve quoted text separately from commentary. ### Steps 1. Add personal notes and source filtering; preserve quoted text separately from commentary. Add personal notes and source filtering; preserve quoted text separately from commentary. Files: `features/annotations_and_notes_export.py`, `templates/annotations_and_notes_export.html` 2. Export Markdown grouped by source with locations and a JSON bundle containing schedules and history. Export Markdown grouped by source with locations and a JSON bundle containing schedules and history. Files: `features/annotations_and_notes_export.py` 3. Exercise the acceptance fixture Use A CSV with two book highlights and a repeated row, one due today and one tomorrow. Check: The Markdown export distinguishes the quote from the user note. Then check: Importing a backup restores the same due queue and review count. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Files: `test/test_annotations_and_notes_export.py` ```sh python -m unittest discover -s test ``` ### Done when - [ ] The Markdown export distinguishes the quote from the user note. - [ ] Importing a backup restores the same due queue and review count. ### Watch out - Do not promise Kindle or publisher integrations; use user-exported files first. ## Phase 5 · Portable delivery and clean-start proof Finish the Readwise replacement with a documented first-run path and a recoverable export. ### Steps 1. Write the user-facing runbook Document prerequisites, every configuration variable, data locations and the three domain workflows: Import without duplicates; Deterministic review; Annotations and notes export. Include the exclusions, actual costs and source check date 2026-09-05. Commands shown earlier that reference project files are files the builder must implement before running them. Files: `README.md`, `.env.example` 2. Create and rehearse a recoverable backup Use sqlite3.Connection.backup for the database in DATA_DIR and pause writers while taking the matching attachment snapshot. Keep schema version, hashes and a manifest for readwise. Restore into a separate empty directory or isolated deployment, with all outbound actions and schedules disabled. Recreate this proof: A CSV with two book highlights and a repeated row, one due today and one tomorrow. Compare ids/counts and open the result before recording the restore date. Never test a restore over the only live copy. Files: `OPERATIONS.md`, `scripts/backup.py` 3. Reproduce the first-run experience Use a new folder and only README instructions to reach the fixture outcome. Install from requirements.txt, initialize storage, run the tests and exercise the UI at 375px and 1280px; use keyboard-only controls and inspect browser errors. Record exactly what passed; do not mark unrun checks complete. Files: `README.md`, `verification.md` ```sh python -m pip install -r requirements.txt python -m unittest discover -s test ``` ### Done when - [ ] A new folder reaches the documented fixture outcome using only README instructions. - [ ] A backup restored in isolation preserves the proof data and can be opened. ### Watch out - Export without an import or restore rehearsal is not verified portability. ## Not in this build - A simple review scheduler is not a claim to reproduce Readwise internal algorithms. - This is a highlight importer with a review queue and source-linked exports; full Readwise feature parity, vendor hosting and support are not included. - broad source integrations, sync, daily review polish, and knowledge-tool exports - publisher bypasses - cross-device mobile capture - high-quality recommendation graph - licensed full-text feeds ## After v1, if you want it - Extend annotations and notes export only after the fixture and recovery checks pass. - Before adding another integration, document its credentials, limits, cost and failure behavior with primary-source links. ===== .env.example ===== # Copy to .env and fill in. Never commit .env; this file documents it. # Required. A new private folder this application creates on first run; never serve it as static files. DATA_DIR=./data/readwise # Required · secret. Generate with python -c "import secrets; print(secrets.token_hex(32))" and save only in .env. SECRET_KEY=replace-with-a-random-secret # Required. Use indie for loopback-only personal work. Product mode must refuse to start until owner login and the deployment gates are configured. APP_MODE=indie # Required. The origin used for local forms and links; replace with the chosen HTTPS origin in product mode. SITE_URL=http://127.0.0.1:5000
You are building a lean indie version of Readwise. Create the following project files first, then implement the application by following them. Keep the files updated as decisions change. Do not collapse this into a single README or prompt. ===== README.md ===== # Readwise · indie build Build a highlight importer with a review queue and source-linked exports. Estimated effort: **multi-day**. Work `BUILD_PLAN.md` top to bottom · every phase ends in a check that has to pass before the next one starts. ## Stack | Part | Choice | Why | | --- | --- | --- | | Runtime | Python 3.12+ and Flask | A small local HTTP application with readable server-side handlers and no JavaScript build pipeline. | | Storage | SQLite through Python sqlite3 | Local ownership with explicit transactions and a portable backup path. | | Interface | Jinja HTML templates, CSS and vanilla JavaScript | Implement the specified screens directly with labelled controls and progressive enhancement. | | Verification | Python unittest and browser acceptance fixtures | Check invariants and the actual user workflow before the next phase. | ## Before you start Have every one of these ready. The plan assumes them from step one. - [ ] **Python 3.12 or newer and a terminal** · Python is free; this local prototype requires no hosting subscription. - Why: The local backend, tests and storage use Python. - Get it: Install Python from python.org. Open a terminal in a new empty project folder. On Windows, use py -3 where this guide says python if python is not on PATH; on macOS/Linux use python3 if needed. Create .venv and activate it before installing packages. - Verify: python --version reports 3.12+ and python -c "import sqlite3" succeeds. - [ ] **A current desktop browser and text editor** · No paid service required for this local step. - Why: You need to view the local interface and edit generated project files. - Get it: Use an installed Chrome, Firefox or Edge browser. Open the empty project folder in your editor; open the terminal there, not in this catalog repository. - Verify: You can create a text file in the project folder and open browser developer tools. - [ ] **Readwise acceptance sample** · No paid service required for this local step. - Why: This fixture makes the first end-to-end check reproducible. - Get it: Create synthetic sample data before implementation: A CSV with two book highlights and a repeated row, one due today and one tomorrow. Save it under fixtures/ with the expected results in fixtures/README.md; use no real credentials or customer records. - Verify: The fixture files and expected outcomes exist and can be inspected without a vendor account. - [ ] **Confirm the bounded replacement** · No paid service required for this local step. - Why: The full commercial product is larger than this guide. - Get it: The deliverable is a highlight importer with a review queue and source-linked exports. Read every exclusion below. Indie mode runs locally; any public or shared use requires the product access and deployment gates first. - Verify: You can name the primary workflow and the vendor features this version deliberately leaves out. ## Quick start ```sh python -m venv .venv python -m pip install Flask Flask-WTF python-dotenv waitress tzdata python -m pip freeze > requirements.txt python -m flask --app app run --host 127.0.0.1 ``` Then copy `.env.example` to `.env` and fill in the values it documents. ## Honest limits This build deliberately does not replace: - A simple review scheduler is not a claim to reproduce Readwise internal algorithms. - This is a highlight importer with a review queue and source-linked exports; full Readwise feature parity, vendor hosting and support are not included. - broad source integrations, sync, daily review polish, and knowledge-tool exports - publisher bypasses - cross-device mobile capture - high-quality recommendation graph - licensed full-text feeds If one of those is essential to you, that is the reason to keep paying for Readwise, and the README should say so rather than pretend. ===== BRIEF.md ===== # Build brief · Readwise The one-shot brief this plan expands. `BUILD_PLAN.md` (or `MILESTONES.md`) is the same sequence broken into steps and checks; where the two disagree, the plan wins. Build me a highlight importer with a review queue and source-linked exports as a bounded replacement for Readwise. Build it in phases in the order below. Do not write the whole product in one pass. Finish the current phase, run its Done when checks, fix failures, then continue. Indie mode completes Phases 1-5. Phase 6 is required before shared or public deployment. ### Stack (fixed, do not substitute) - Runtime: Python 3.12+ and Flask. A small local HTTP application with readable server-side handlers and no JavaScript build pipeline. - Storage: SQLite through Python sqlite3. Local ownership with explicit transactions and a portable backup path. - Interface: Jinja HTML templates, CSS and vanilla JavaScript. Implement the specified screens directly with labelled controls and progressive enhancement. - Verification: Python unittest and browser acceptance fixtures. Check invariants and the actual user workflow before the next phase. ### Data model (create this before Phase 1) - sources(id,title,author,source_url) - highlights(id,source_id,text,location,import_hash) - reviews(id,highlight_id,at,rating) - schedules(highlight_id,due_date,interval_days) - notes(id,highlight_id,text) - Use stable ids and explicit relationships; add auxiliary tables named by the phases before those phases use them. - Acceptance fixture: A CSV with two book highlights and a repeated row, one due today and one tomorrow. ### Prerequisites and configuration - Python 3.12 or newer and a terminal: Install Python from python.org. Open a terminal in a new empty project folder. On Windows, use py -3 where this guide says python if python is not on PATH; on macOS/Linux use python3 if needed. Create .venv and activate it before installing packages. Verify: python --version reports 3.12+ and python -c "import sqlite3" succeeds. Cost: Python is free; this local prototype requires no hosting subscription. - A current desktop browser and text editor: Use an installed Chrome, Firefox or Edge browser. Open the empty project folder in your editor; open the terminal there, not in this catalog repository. Verify: You can create a text file in the project folder and open browser developer tools. Cost: No paid service required for this local step. - Readwise acceptance sample: Create synthetic sample data before implementation: A CSV with two book highlights and a repeated row, one due today and one tomorrow. Save it under fixtures/ with the expected results in fixtures/README.md; use no real credentials or customer records. Verify: The fixture files and expected outcomes exist and can be inspected without a vendor account. Cost: No paid service required for this local step. - Confirm the bounded replacement: The deliverable is a highlight importer with a review queue and source-linked exports. Read every exclusion below. Indie mode runs locally; any public or shared use requires the product access and deployment gates first. Verify: You can name the primary workflow and the vendor features this version deliberately leaves out. Cost: No paid service required for this local step. - Configuration: DATA_DIR, SECRET_KEY, APP_MODE, SITE_URL. Ship .env.example, replace placeholders and exclude secrets from git. ### Phase 1 · Local foundation and data contract Build: Create the runnable local foundation for a highlight importer with a review queue and source-linked exports, including the real schema and acceptance fixture. - Run the venv command first, then stop and activate it before running the remaining commands. Use your OS instructions: Windows .venv\Scripts\activate.bat in cmd, or .venv\Scripts\Activate.ps1 in PowerShell; macOS/Linux source .venv/bin/activate. Then install the listed packages. Create app.py exposing app, load .env with python-dotenv, and add a /healthz route. Freeze tested dependency versions to requirements.txt. Create .env manually from .env.example; replace SECRET_KEY before launch. Commands, after creating the named files: `python -m venv .venv`; `python -m pip install Flask Flask-WTF python-dotenv waitress tzdata`; `python -m pip freeze > requirements.txt`; `python -m flask --app app run --host 127.0.0.1`. - For database-backed state create schema.sql and db.py using this model: sources(id,title,author,source_url); highlights(id,source_id,text,location,import_hash); reviews(id,highlight_id,at,rating); schedules(highlight_id,due_date,interval_days); notes(id,highlight_id,text). Add the auxiliary relationships explicitly used in later phases; use stable ids, foreign keys, parameterized values and transactions. For canonical files use atomic replacement and hashes instead. Implement python manage.py init and python manage.py seed to create only synthetic data: A CSV with two book highlights and a repeated row, one due today and one tomorrow. Re-running init must not erase data. Commands, after creating the named files: `python manage.py init`; `python manage.py seed`. - Install Flask-WTF CSRF protection for forms and same-origin fetches, validate Host and Origin against SITE_URL, bound inputs and escape output. Deliberately public intake endpoints get bounded validation and rate limits; signed provider webhooks use signature checks instead of browser CSRF tokens. All other admin routes stay local until product authentication exists. When a later phase tests viewer/member permissions, implement the users, hashed passwords, expiring server sessions and role checks in this foundation first; product mode must never use a fabricated identity from request input. Add error, empty, keyboard-focus and retry states now. - Trap: The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation. Done when: The documented start command serves /healthz and the initial screen at http://127.0.0.1:5000. Restarting preserves the seeded records or canonical files; running init again deletes nothing. A cross-origin state-changing request to an admin route is refused. Do not build yet: Do not start import without duplicates until these checks pass. ### Phase 2 · Import without duplicates Build: Import without duplicates for Readwise: Preview CSV mapping for title, author, highlight and location; retain source provenance per highlight. - Preview CSV mapping for title, author, highlight and location; retain source provenance per highlight. - Generate an import identity from source, location and normalized text and show repeated rows before commit. - Use A CSV with two book highlights and a repeated row, one due today and one tomorrow. Check: Importing the fixture twice leaves two highlights. Then check: A changed annotation is not discarded as a duplicate highlight. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Commands, after creating the named files: `python -m unittest discover -s test`. - Trap: Source title alone cannot uniquely identify a book edition or web source. Done when: Importing the fixture twice leaves two highlights. A changed annotation is not discarded as a duplicate highlight. Do not build yet: Do not start deterministic review until these checks pass. ### Phase 3 · Deterministic review Build: Deterministic review for Readwise: Build a due-today queue with again/good responses; define fixed interval rules in code and store every review event. - Build a due-today queue with again/good responses; define fixed interval rules in code and store every review event. - Use the user-selected local date for scheduling and show the next due date before saving a response. - Use A CSV with two book highlights and a repeated row, one due today and one tomorrow. Check: Again schedules tomorrow and Good doubles the previous interval according to the documented rule. Then check: Refreshing after answering does not submit a second review. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Commands, after creating the named files: `python -m unittest discover -s test`. - Trap: A simple review scheduler is not a claim to reproduce Readwise internal algorithms. Done when: Again schedules tomorrow and Good doubles the previous interval according to the documented rule. Refreshing after answering does not submit a second review. Do not build yet: Do not start annotations and notes export until these checks pass. ### Phase 4 · Annotations and notes export Build: Annotations and notes export for Readwise: Add personal notes and source filtering; preserve quoted text separately from commentary. - Add personal notes and source filtering; preserve quoted text separately from commentary. - Export Markdown grouped by source with locations and a JSON bundle containing schedules and history. - Use A CSV with two book highlights and a repeated row, one due today and one tomorrow. Check: The Markdown export distinguishes the quote from the user note. Then check: Importing a backup restores the same due queue and review count. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Commands, after creating the named files: `python -m unittest discover -s test`. - Trap: Do not promise Kindle or publisher integrations; use user-exported files first. Done when: The Markdown export distinguishes the quote from the user note. Importing a backup restores the same due queue and review count. Do not build yet: Do not start portable delivery and clean-start proof until these checks pass. ### Phase 5 · Portable delivery and clean-start proof Build: Finish the Readwise replacement with a documented first-run path and a recoverable export. - Document prerequisites, every configuration variable, data locations and the three domain workflows: Import without duplicates; Deterministic review; Annotations and notes export. Include the exclusions, actual costs and source check date 2026-09-05. Commands shown earlier that reference project files are files the builder must implement before running them. - Use sqlite3.Connection.backup for the database in DATA_DIR and pause writers while taking the matching attachment snapshot. Keep schema version, hashes and a manifest for readwise. Restore into a separate empty directory or isolated deployment, with all outbound actions and schedules disabled. Recreate this proof: A CSV with two book highlights and a repeated row, one due today and one tomorrow. Compare ids/counts and open the result before recording the restore date. Never test a restore over the only live copy. - Use a new folder and only README instructions to reach the fixture outcome. Install from requirements.txt, initialize storage, run the tests and exercise the UI at 375px and 1280px; use keyboard-only controls and inspect browser errors. Record exactly what passed; do not mark unrun checks complete. Commands, after creating the named files: `python -m pip install -r requirements.txt`; `python -m unittest discover -s test`. - Trap: Export without an import or restore rehearsal is not verified portability. Done when: A new folder reaches the documented fixture outcome using only README instructions. A backup restored in isolation preserves the proof data and can be opened. Do not build yet: Do not start operate and share with access controls until these checks pass. ### Phase 6 · Operate and share with access controls (product-builder only) Build: Product-builder only: make a highlight importer with a review queue and source-linked exports operable for its stated audience before allowing remote access. - Add owner/member/viewer authorization as appropriate, password hashes through Werkzeug, expiring server-side sessions, CSRF and login rate limits. Add users, sessions and audit schema migrations plus an owner-init command prompting securely for its password. Enforce ownership on every private read/write/download and fail closed when product setup is incomplete. Existing learner or admin identities must use this same boundary. - Serve app:app with Waitress on loopback behind Caddy HTTPS. Configure trusted proxy headers narrowly, Secure/HttpOnly/SameSite cookies, upload limits, request ids and structured logs without private content. Run background jobs as a separate supervised process when the domain workflow requires them. Commands, after creating the named files: `waitress-serve --listen=127.0.0.1:5000 app:app`. - Add a scheduled encrypted off-host backup using this procedure: Use sqlite3.Connection.backup for the database in DATA_DIR and pause writers while taking the matching attachment snapshot. Keep schema version, hashes and a manifest for readwise. Monitor health, disk space, failed jobs and backup age. Stop the service to test an alert; rehearse recovery with outbound effects disabled and record recovery time. Rotate any exposed credentials and require reconciliation before resuming queues. - Trap: Product mode is additional engineering, not a switch that makes a local prototype production-ready. Done when: An unauthenticated visitor cannot read private records, download private files or mutate the admin surface. A viewer cannot mutate data by making a direct request, and guessed ids cannot cross ownership boundaries. Stopping the service triggers the configured alert and the latest off-host backup restores the fixture in isolation. Do not build yet: Do not add new providers or vendor-scale features until the release gates are recorded. ### Out of scope (and why) - A simple review scheduler is not a claim to reproduce Readwise internal algorithms. - This is a highlight importer with a review queue and source-linked exports; full Readwise feature parity, vendor hosting and support are not included. - broad source integrations, sync, daily review polish, and knowledge-tool exports: retain the paid product if this capability is essential; it is outside this bounded build. - publisher bypasses: retain the paid product if this capability is essential; it is outside this bounded build. - cross-device mobile capture: retain the paid product if this capability is essential; it is outside this bounded build. - high-quality recommendation graph: retain the paid product if this capability is essential; it is outside this bounded build. - licensed full-text feeds: retain the paid product if this capability is essential; it is outside this bounded build. ### README must contain - Exact install, configure, initialize, start, test and recovery commands for a clean folder. - The schema, fixture, acceptance results, private data locations and export format. - Every prerequisite and secret source, actual running costs and deliberately excluded capabilities. - An honest distinction between tests actually run and checks still awaiting real credentials or deployment. - Dependency documentation reviewed 2026-09-05: https://flask.palletsprojects.com/en/stable/installation/ ; https://docs.python.org/3/library/sqlite3.html ; https://flask-wtf.readthedocs.io/en/1.2.x/csrf/ ; https://docs.pylonsproject.org/projects/waitress/en/stable/usage.html. Recheck before upgrading; freeze the versions actually tested. ===== AGENTS.md ===== # Agent instructions · Readwise indie build - Read `README.md` and `BUILD_PLAN.md` before writing code. The stack is fixed: Python 3.12+ and Flask, SQLite through Python sqlite3, Jinja HTML templates, CSS and vanilla JavaScript, Python unittest and browser acceptance fixtures. Do not substitute. - Work one phase at a time, in order. Do not start a phase until every "Done when" item of the previous one passes. - Prefer the fewest moving parts that satisfy the step. No frameworks, services or dependencies the plan does not name. - Secrets live in `.env`, never in source or logs. Keep `.env.example` current when a variable is introduced. - Do not invent cryptography, security guarantees, APIs or compliance claims. - Add a focused test for every destructive, security-sensitive or data-loss path the plan names. - Run the project checks before declaring a phase complete, and record any deliberate shortcut in the README under "Tradeoffs". ## Known traps - The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation. - Source title alone cannot uniquely identify a book edition or web source. - A simple review scheduler is not a claim to reproduce Readwise internal algorithms. - Do not promise Kindle or publisher integrations; use user-exported files first. - Export without an import or restore rehearsal is not verified portability. ===== BUILD_PLAN.md ===== # Build plan · Readwise Build a highlight importer with a review queue and source-linked exports. Phases are in dependency order. Each ends in a "Done when" list; treat an unticked item as a blocker, not a note. ## Phase 1 · Local foundation and data contract Create the runnable local foundation for a highlight importer with a review queue and source-linked exports, including the real schema and acceptance fixture. ### Steps 1. Create and start the local application Run the venv command first, then stop and activate it before running the remaining commands. Use your OS instructions: Windows .venv\Scripts\activate.bat in cmd, or .venv\Scripts\Activate.ps1 in PowerShell; macOS/Linux source .venv/bin/activate. Then install the listed packages. Create app.py exposing app, load .env with python-dotenv, and add a /healthz route. Freeze tested dependency versions to requirements.txt. Create .env manually from .env.example; replace SECRET_KEY before launch. Files: `app.py`, `requirements.txt`, `.env.example`, `.gitignore` ```sh python -m venv .venv python -m pip install Flask Flask-WTF python-dotenv waitress tzdata python -m pip freeze > requirements.txt python -m flask --app app run --host 127.0.0.1 ``` 2. Implement storage and seed the named fixture For database-backed state create schema.sql and db.py using this model: sources(id,title,author,source_url); highlights(id,source_id,text,location,import_hash); reviews(id,highlight_id,at,rating); schedules(highlight_id,due_date,interval_days); notes(id,highlight_id,text). Add the auxiliary relationships explicitly used in later phases; use stable ids, foreign keys, parameterized values and transactions. For canonical files use atomic replacement and hashes instead. Implement python manage.py init and python manage.py seed to create only synthetic data: A CSV with two book highlights and a repeated row, one due today and one tomorrow. Re-running init must not erase data. Files: `schema.sql`, `db.py`, `manage.py`, `fixtures/README.md` ```sh python manage.py init python manage.py seed ``` 3. Protect the local request boundary Install Flask-WTF CSRF protection for forms and same-origin fetches, validate Host and Origin against SITE_URL, bound inputs and escape output. Deliberately public intake endpoints get bounded validation and rate limits; signed provider webhooks use signature checks instead of browser CSRF tokens. All other admin routes stay local until product authentication exists. When a later phase tests viewer/member permissions, implement the users, hashed passwords, expiring server sessions and role checks in this foundation first; product mode must never use a fabricated identity from request input. Add error, empty, keyboard-focus and retry states now. Files: `app.py`, `templates/base.html`, `test/test_foundation.py` ### Done when - [ ] The documented start command serves /healthz and the initial screen at http://127.0.0.1:5000. - [ ] Restarting preserves the seeded records or canonical files; running init again deletes nothing. - [ ] A cross-origin state-changing request to an admin route is refused. ### Watch out - The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation. ## Phase 2 · Import without duplicates Import without duplicates for Readwise: Preview CSV mapping for title, author, highlight and location; retain source provenance per highlight. ### Steps 1. Preview CSV mapping for title, author, highlight and location; retain source provenance per highlight. Preview CSV mapping for title, author, highlight and location; retain source provenance per highlight. Files: `features/import_without_duplicates.py`, `templates/import_without_duplicates.html` 2. Generate an import identity from source, location and normalized text and show repeated rows before commit. Generate an import identity from source, location and normalized text and show repeated rows before commit. Files: `features/import_without_duplicates.py` 3. Exercise the acceptance fixture Use A CSV with two book highlights and a repeated row, one due today and one tomorrow. Check: Importing the fixture twice leaves two highlights. Then check: A changed annotation is not discarded as a duplicate highlight. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Files: `test/test_import_without_duplicates.py` ```sh python -m unittest discover -s test ``` ### Done when - [ ] Importing the fixture twice leaves two highlights. - [ ] A changed annotation is not discarded as a duplicate highlight. ### Watch out - Source title alone cannot uniquely identify a book edition or web source. ## Phase 3 · Deterministic review Deterministic review for Readwise: Build a due-today queue with again/good responses; define fixed interval rules in code and store every review event. ### Steps 1. Build a due-today queue with again/good responses; define fixed interval rules in code and store every review event. Build a due-today queue with again/good responses; define fixed interval rules in code and store every review event. Files: `features/deterministic_review.py`, `templates/deterministic_review.html` 2. Use the user-selected local date for scheduling and show the next due date before saving a response. Use the user-selected local date for scheduling and show the next due date before saving a response. Files: `features/deterministic_review.py` 3. Exercise the acceptance fixture Use A CSV with two book highlights and a repeated row, one due today and one tomorrow. Check: Again schedules tomorrow and Good doubles the previous interval according to the documented rule. Then check: Refreshing after answering does not submit a second review. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Files: `test/test_deterministic_review.py` ```sh python -m unittest discover -s test ``` ### Done when - [ ] Again schedules tomorrow and Good doubles the previous interval according to the documented rule. - [ ] Refreshing after answering does not submit a second review. ### Watch out - A simple review scheduler is not a claim to reproduce Readwise internal algorithms. ## Phase 4 · Annotations and notes export Annotations and notes export for Readwise: Add personal notes and source filtering; preserve quoted text separately from commentary. ### Steps 1. Add personal notes and source filtering; preserve quoted text separately from commentary. Add personal notes and source filtering; preserve quoted text separately from commentary. Files: `features/annotations_and_notes_export.py`, `templates/annotations_and_notes_export.html` 2. Export Markdown grouped by source with locations and a JSON bundle containing schedules and history. Export Markdown grouped by source with locations and a JSON bundle containing schedules and history. Files: `features/annotations_and_notes_export.py` 3. Exercise the acceptance fixture Use A CSV with two book highlights and a repeated row, one due today and one tomorrow. Check: The Markdown export distinguishes the quote from the user note. Then check: Importing a backup restores the same due queue and review count. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Files: `test/test_annotations_and_notes_export.py` ```sh python -m unittest discover -s test ``` ### Done when - [ ] The Markdown export distinguishes the quote from the user note. - [ ] Importing a backup restores the same due queue and review count. ### Watch out - Do not promise Kindle or publisher integrations; use user-exported files first. ## Phase 5 · Portable delivery and clean-start proof Finish the Readwise replacement with a documented first-run path and a recoverable export. ### Steps 1. Write the user-facing runbook Document prerequisites, every configuration variable, data locations and the three domain workflows: Import without duplicates; Deterministic review; Annotations and notes export. Include the exclusions, actual costs and source check date 2026-09-05. Commands shown earlier that reference project files are files the builder must implement before running them. Files: `README.md`, `.env.example` 2. Create and rehearse a recoverable backup Use sqlite3.Connection.backup for the database in DATA_DIR and pause writers while taking the matching attachment snapshot. Keep schema version, hashes and a manifest for readwise. Restore into a separate empty directory or isolated deployment, with all outbound actions and schedules disabled. Recreate this proof: A CSV with two book highlights and a repeated row, one due today and one tomorrow. Compare ids/counts and open the result before recording the restore date. Never test a restore over the only live copy. Files: `OPERATIONS.md`, `scripts/backup.py` 3. Reproduce the first-run experience Use a new folder and only README instructions to reach the fixture outcome. Install from requirements.txt, initialize storage, run the tests and exercise the UI at 375px and 1280px; use keyboard-only controls and inspect browser errors. Record exactly what passed; do not mark unrun checks complete. Files: `README.md`, `verification.md` ```sh python -m pip install -r requirements.txt python -m unittest discover -s test ``` ### Done when - [ ] A new folder reaches the documented fixture outcome using only README instructions. - [ ] A backup restored in isolation preserves the proof data and can be opened. ### Watch out - Export without an import or restore rehearsal is not verified portability. ## Not in this build - A simple review scheduler is not a claim to reproduce Readwise internal algorithms. - This is a highlight importer with a review queue and source-linked exports; full Readwise feature parity, vendor hosting and support are not included. - broad source integrations, sync, daily review polish, and knowledge-tool exports - publisher bypasses - cross-device mobile capture - high-quality recommendation graph - licensed full-text feeds ## After v1, if you want it - Extend annotations and notes export only after the fixture and recovery checks pass. - Before adding another integration, document its credentials, limits, cost and failure behavior with primary-source links. ===== .env.example ===== # Copy to .env and fill in. Never commit .env; this file documents it. # Required. A new private folder this application creates on first run; never serve it as static files. DATA_DIR=./data/readwise # Required · secret. Generate with python -c "import secrets; print(secrets.token_hex(32))" and save only in .env. SECRET_KEY=replace-with-a-random-secret # Required. Use indie for loopback-only personal work. Product mode must refuse to start until owner login and the deployment gates are configured. APP_MODE=indie # Required. The origin used for local forms and links; replace with the chosen HTTPS origin in product mode. SITE_URL=http://127.0.0.1:5000
You are building a production product version of Readwise. Create the following project files first, then implement the application by following them. Keep the files updated as decisions change. Do not collapse this into a single README or prompt. ===== PRODUCT.md ===== # Readwise · product brief ## Problem The core loop is buildable, but a dependable replacement becomes a real weekend or multi-day project. For Readwise, import highlights from user-exported files, review them with spaced repetition, and export notes. The hard boundary is broad source integrations, sync, daily review polish, and knowledge-tool exports, plus capture polish, sync, and content partnerships. ## Product outcome An operated version of a highlight importer with a review queue and source-linked exports, with authorized access, restore evidence and honest scope limits. ## Target user A builder who needs a maintainable product foundation, not a one-off demo. ## Required capabilities - Node.js 22 - local disk - optional browser bookmarklet - user-supplied RSS feeds ## Explicit non-goals for v1 - A simple review scheduler is not a claim to reproduce Readwise internal algorithms. - This is a highlight importer with a review queue and source-linked exports; full Readwise feature parity, vendor hosting and support are not included. - broad source integrations, sync, daily review polish, and knowledge-tool exports - publisher bypasses - cross-device mobile capture - high-quality recommendation graph - licensed full-text feeds ## Success criteria - Importing the fixture twice leaves two highlights. - Again schedules tomorrow and Good doubles the previous interval according to the documented rule. - The Markdown export distinguishes the quote from the user note. - A private-data authorization check passes using a second identity. - An off-host restore drill has a date, observed result and recovery time in OPERATIONS.md. - README names the excluded vendor capabilities and actual provider/hosting costs. ===== BRIEF.md ===== # Build brief · Readwise The one-shot brief this plan expands. `BUILD_PLAN.md` (or `MILESTONES.md`) is the same sequence broken into steps and checks; where the two disagree, the plan wins. Build me a highlight importer with a review queue and source-linked exports as a bounded replacement for Readwise. Build it in phases in the order below. Do not write the whole product in one pass. Finish the current phase, run its Done when checks, fix failures, then continue. Indie mode completes Phases 1-5. Phase 6 is required before shared or public deployment. ### Stack (fixed, do not substitute) - Runtime: Python 3.12+ and Flask. A small local HTTP application with readable server-side handlers and no JavaScript build pipeline. - Storage: SQLite through Python sqlite3. Local ownership with explicit transactions and a portable backup path. - Interface: Jinja HTML templates, CSS and vanilla JavaScript. Implement the specified screens directly with labelled controls and progressive enhancement. - Verification: Python unittest and browser acceptance fixtures. Check invariants and the actual user workflow before the next phase. ### Data model (create this before Phase 1) - sources(id,title,author,source_url) - highlights(id,source_id,text,location,import_hash) - reviews(id,highlight_id,at,rating) - schedules(highlight_id,due_date,interval_days) - notes(id,highlight_id,text) - Use stable ids and explicit relationships; add auxiliary tables named by the phases before those phases use them. - Acceptance fixture: A CSV with two book highlights and a repeated row, one due today and one tomorrow. ### Prerequisites and configuration - Python 3.12 or newer and a terminal: Install Python from python.org. Open a terminal in a new empty project folder. On Windows, use py -3 where this guide says python if python is not on PATH; on macOS/Linux use python3 if needed. Create .venv and activate it before installing packages. Verify: python --version reports 3.12+ and python -c "import sqlite3" succeeds. Cost: Python is free; this local prototype requires no hosting subscription. - A current desktop browser and text editor: Use an installed Chrome, Firefox or Edge browser. Open the empty project folder in your editor; open the terminal there, not in this catalog repository. Verify: You can create a text file in the project folder and open browser developer tools. Cost: No paid service required for this local step. - Readwise acceptance sample: Create synthetic sample data before implementation: A CSV with two book highlights and a repeated row, one due today and one tomorrow. Save it under fixtures/ with the expected results in fixtures/README.md; use no real credentials or customer records. Verify: The fixture files and expected outcomes exist and can be inspected without a vendor account. Cost: No paid service required for this local step. - Confirm the bounded replacement: The deliverable is a highlight importer with a review queue and source-linked exports. Read every exclusion below. Indie mode runs locally; any public or shared use requires the product access and deployment gates first. Verify: You can name the primary workflow and the vendor features this version deliberately leaves out. Cost: No paid service required for this local step. - Configuration: DATA_DIR, SECRET_KEY, APP_MODE, SITE_URL. Ship .env.example, replace placeholders and exclude secrets from git. ### Phase 1 · Local foundation and data contract Build: Create the runnable local foundation for a highlight importer with a review queue and source-linked exports, including the real schema and acceptance fixture. - Run the venv command first, then stop and activate it before running the remaining commands. Use your OS instructions: Windows .venv\Scripts\activate.bat in cmd, or .venv\Scripts\Activate.ps1 in PowerShell; macOS/Linux source .venv/bin/activate. Then install the listed packages. Create app.py exposing app, load .env with python-dotenv, and add a /healthz route. Freeze tested dependency versions to requirements.txt. Create .env manually from .env.example; replace SECRET_KEY before launch. Commands, after creating the named files: `python -m venv .venv`; `python -m pip install Flask Flask-WTF python-dotenv waitress tzdata`; `python -m pip freeze > requirements.txt`; `python -m flask --app app run --host 127.0.0.1`. - For database-backed state create schema.sql and db.py using this model: sources(id,title,author,source_url); highlights(id,source_id,text,location,import_hash); reviews(id,highlight_id,at,rating); schedules(highlight_id,due_date,interval_days); notes(id,highlight_id,text). Add the auxiliary relationships explicitly used in later phases; use stable ids, foreign keys, parameterized values and transactions. For canonical files use atomic replacement and hashes instead. Implement python manage.py init and python manage.py seed to create only synthetic data: A CSV with two book highlights and a repeated row, one due today and one tomorrow. Re-running init must not erase data. Commands, after creating the named files: `python manage.py init`; `python manage.py seed`. - Install Flask-WTF CSRF protection for forms and same-origin fetches, validate Host and Origin against SITE_URL, bound inputs and escape output. Deliberately public intake endpoints get bounded validation and rate limits; signed provider webhooks use signature checks instead of browser CSRF tokens. All other admin routes stay local until product authentication exists. When a later phase tests viewer/member permissions, implement the users, hashed passwords, expiring server sessions and role checks in this foundation first; product mode must never use a fabricated identity from request input. Add error, empty, keyboard-focus and retry states now. - Trap: The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation. Done when: The documented start command serves /healthz and the initial screen at http://127.0.0.1:5000. Restarting preserves the seeded records or canonical files; running init again deletes nothing. A cross-origin state-changing request to an admin route is refused. Do not build yet: Do not start import without duplicates until these checks pass. ### Phase 2 · Import without duplicates Build: Import without duplicates for Readwise: Preview CSV mapping for title, author, highlight and location; retain source provenance per highlight. - Preview CSV mapping for title, author, highlight and location; retain source provenance per highlight. - Generate an import identity from source, location and normalized text and show repeated rows before commit. - Use A CSV with two book highlights and a repeated row, one due today and one tomorrow. Check: Importing the fixture twice leaves two highlights. Then check: A changed annotation is not discarded as a duplicate highlight. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Commands, after creating the named files: `python -m unittest discover -s test`. - Trap: Source title alone cannot uniquely identify a book edition or web source. Done when: Importing the fixture twice leaves two highlights. A changed annotation is not discarded as a duplicate highlight. Do not build yet: Do not start deterministic review until these checks pass. ### Phase 3 · Deterministic review Build: Deterministic review for Readwise: Build a due-today queue with again/good responses; define fixed interval rules in code and store every review event. - Build a due-today queue with again/good responses; define fixed interval rules in code and store every review event. - Use the user-selected local date for scheduling and show the next due date before saving a response. - Use A CSV with two book highlights and a repeated row, one due today and one tomorrow. Check: Again schedules tomorrow and Good doubles the previous interval according to the documented rule. Then check: Refreshing after answering does not submit a second review. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Commands, after creating the named files: `python -m unittest discover -s test`. - Trap: A simple review scheduler is not a claim to reproduce Readwise internal algorithms. Done when: Again schedules tomorrow and Good doubles the previous interval according to the documented rule. Refreshing after answering does not submit a second review. Do not build yet: Do not start annotations and notes export until these checks pass. ### Phase 4 · Annotations and notes export Build: Annotations and notes export for Readwise: Add personal notes and source filtering; preserve quoted text separately from commentary. - Add personal notes and source filtering; preserve quoted text separately from commentary. - Export Markdown grouped by source with locations and a JSON bundle containing schedules and history. - Use A CSV with two book highlights and a repeated row, one due today and one tomorrow. Check: The Markdown export distinguishes the quote from the user note. Then check: Importing a backup restores the same due queue and review count. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Commands, after creating the named files: `python -m unittest discover -s test`. - Trap: Do not promise Kindle or publisher integrations; use user-exported files first. Done when: The Markdown export distinguishes the quote from the user note. Importing a backup restores the same due queue and review count. Do not build yet: Do not start portable delivery and clean-start proof until these checks pass. ### Phase 5 · Portable delivery and clean-start proof Build: Finish the Readwise replacement with a documented first-run path and a recoverable export. - Document prerequisites, every configuration variable, data locations and the three domain workflows: Import without duplicates; Deterministic review; Annotations and notes export. Include the exclusions, actual costs and source check date 2026-09-05. Commands shown earlier that reference project files are files the builder must implement before running them. - Use sqlite3.Connection.backup for the database in DATA_DIR and pause writers while taking the matching attachment snapshot. Keep schema version, hashes and a manifest for readwise. Restore into a separate empty directory or isolated deployment, with all outbound actions and schedules disabled. Recreate this proof: A CSV with two book highlights and a repeated row, one due today and one tomorrow. Compare ids/counts and open the result before recording the restore date. Never test a restore over the only live copy. - Use a new folder and only README instructions to reach the fixture outcome. Install from requirements.txt, initialize storage, run the tests and exercise the UI at 375px and 1280px; use keyboard-only controls and inspect browser errors. Record exactly what passed; do not mark unrun checks complete. Commands, after creating the named files: `python -m pip install -r requirements.txt`; `python -m unittest discover -s test`. - Trap: Export without an import or restore rehearsal is not verified portability. Done when: A new folder reaches the documented fixture outcome using only README instructions. A backup restored in isolation preserves the proof data and can be opened. Do not build yet: Do not start operate and share with access controls until these checks pass. ### Phase 6 · Operate and share with access controls (product-builder only) Build: Product-builder only: make a highlight importer with a review queue and source-linked exports operable for its stated audience before allowing remote access. - Add owner/member/viewer authorization as appropriate, password hashes through Werkzeug, expiring server-side sessions, CSRF and login rate limits. Add users, sessions and audit schema migrations plus an owner-init command prompting securely for its password. Enforce ownership on every private read/write/download and fail closed when product setup is incomplete. Existing learner or admin identities must use this same boundary. - Serve app:app with Waitress on loopback behind Caddy HTTPS. Configure trusted proxy headers narrowly, Secure/HttpOnly/SameSite cookies, upload limits, request ids and structured logs without private content. Run background jobs as a separate supervised process when the domain workflow requires them. Commands, after creating the named files: `waitress-serve --listen=127.0.0.1:5000 app:app`. - Add a scheduled encrypted off-host backup using this procedure: Use sqlite3.Connection.backup for the database in DATA_DIR and pause writers while taking the matching attachment snapshot. Keep schema version, hashes and a manifest for readwise. Monitor health, disk space, failed jobs and backup age. Stop the service to test an alert; rehearse recovery with outbound effects disabled and record recovery time. Rotate any exposed credentials and require reconciliation before resuming queues. - Trap: Product mode is additional engineering, not a switch that makes a local prototype production-ready. Done when: An unauthenticated visitor cannot read private records, download private files or mutate the admin surface. A viewer cannot mutate data by making a direct request, and guessed ids cannot cross ownership boundaries. Stopping the service triggers the configured alert and the latest off-host backup restores the fixture in isolation. Do not build yet: Do not add new providers or vendor-scale features until the release gates are recorded. ### Out of scope (and why) - A simple review scheduler is not a claim to reproduce Readwise internal algorithms. - This is a highlight importer with a review queue and source-linked exports; full Readwise feature parity, vendor hosting and support are not included. - broad source integrations, sync, daily review polish, and knowledge-tool exports: retain the paid product if this capability is essential; it is outside this bounded build. - publisher bypasses: retain the paid product if this capability is essential; it is outside this bounded build. - cross-device mobile capture: retain the paid product if this capability is essential; it is outside this bounded build. - high-quality recommendation graph: retain the paid product if this capability is essential; it is outside this bounded build. - licensed full-text feeds: retain the paid product if this capability is essential; it is outside this bounded build. ### README must contain - Exact install, configure, initialize, start, test and recovery commands for a clean folder. - The schema, fixture, acceptance results, private data locations and export format. - Every prerequisite and secret source, actual running costs and deliberately excluded capabilities. - An honest distinction between tests actually run and checks still awaiting real credentials or deployment. - Dependency documentation reviewed 2026-09-05: https://flask.palletsprojects.com/en/stable/installation/ ; https://docs.python.org/3/library/sqlite3.html ; https://flask-wtf.readthedocs.io/en/1.2.x/csrf/ ; https://docs.pylonsproject.org/projects/waitress/en/stable/usage.html. Recheck before upgrading; freeze the versions actually tested. ===== ARCHITECTURE.md ===== # Architecture · Readwise ## Stack | Part | Choice | Why | | --- | --- | --- | | Runtime | Python 3.12+ and Flask | A small local HTTP application with readable server-side handlers and no JavaScript build pipeline. | | Storage | SQLite through Python sqlite3 | Local ownership with explicit transactions and a portable backup path. | | Interface | Jinja HTML templates, CSS and vanilla JavaScript | Implement the specified screens directly with labelled controls and progressive enhancement. | | Verification | Python unittest and browser acceptance fixtures | Check invariants and the actual user workflow before the next phase. | ## Modules Each module has one owner concern and a documented way to replace it. | Module | Owns | How to replace it | | --- | --- | --- | | Data and identity | sources(id,title,author,source_url); highlights(id,source_id,text,location,import_hash); reviews(id,highlight_id,at,rating); schedules(highlight_id,due_date,interval_days); notes(id,highlight_id,text) | Keep stable ids and a versioned repository interface; migrate storage behind it with a fixture round-trip. | | Import without duplicates | Preview CSV mapping for title, author, highlight and location; retain source provenance per highlight. | Keep the acceptance contract: Importing the fixture twice leaves two highlights. Replace only this module after replaying its fixture; preserve ids and existing records. | | Deterministic review | Build a due-today queue with again/good responses; define fixed interval rules in code and store every review event. | Keep the acceptance contract: Again schedules tomorrow and Good doubles the previous interval according to the documented rule. Replace only this module after replaying its fixture; preserve ids and existing records. | | Annotations and notes export | Add personal notes and source filtering; preserve quoted text separately from commentary. | Keep the acceptance contract: The Markdown export distinguishes the quote from the user note. Replace only this module after replaying its fixture; preserve ids and existing records. | | Operations | Use sqlite3.Connection.backup for the database in DATA_DIR and pause writers while taking the matching attachment snapshot. Keep schema version, hashes and a manifest for readwise. | Change host or backup destination only after an isolated restore and authorization check. | ## Configuration Every runtime setting is an environment variable documented in `.env.example`, validated at startup, with a safe local default wherever one exists. - `DATA_DIR` · required · A new private folder this application creates on first run; never serve it as static files. - `SECRET_KEY` · required, secret · Generate with python -c "import secrets; print(secrets.token_hex(32))" and save only in .env. - `APP_MODE` · required · Use indie for loopback-only personal work. Product mode must refuse to start until owner login and the deployment gates are configured. - `SITE_URL` · required · The origin used for local forms and links; replace with the chosen HTTPS origin in product mode. ## Production baseline - Security: least privilege, input validation at every boundary, secret redaction in logs, rate limits on abuse-prone paths, no invented security primitives. - Data: explicit schema and migrations, transactional writes where integrity matters, backup and restore procedures that have been exercised. - Integrations: adapters around third-party providers, idempotent webhook or job processing, bounded retries, timeouts. - Observability: structured logs with request or operation ids, an error-tracking hook, and health and readiness checks where a server exists. - Quality: unit tests for domain rules, integration tests at module boundaries, one end-to-end test of the critical path. ## Decision records For each dependency in the stack table, keep a short note: why it was chosen, its failure mode, and how it is replaced. Do not add infrastructure until a requirement in `PRODUCT.md` justifies it. ===== AGENTS.md ===== # Agent instructions · Readwise product build - Read `PRODUCT.md` and `ARCHITECTURE.md` before changing code. The stack is fixed: Python 3.12+ and Flask, SQLite through Python sqlite3, Jinja HTML templates, CSS and vanilla JavaScript, Python unittest and browser acceptance fixtures. - Implement milestone by milestone from `MILESTONES.md`; keep each change reviewable and leave the application runnable at every commit. - Treat authentication, payments, encryption, imports, webhooks and destructive actions as high-risk boundaries when present. - Never invent cryptography or silently weaken a requirement to make a check pass. - Put every external service behind an interface with a deterministic fake for tests. - Add migrations and rollback or recovery notes for every persistent data change. - Log useful operational context without credentials, tokens, passwords or personal data. - Update documentation and run every check before completing a milestone. ## Known traps - The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation. - Source title alone cannot uniquely identify a book edition or web source. - A simple review scheduler is not a claim to reproduce Readwise internal algorithms. - Do not promise Kindle or publisher integrations; use user-exported files first. - Export without an import or restore rehearsal is not verified portability. - Product mode is additional engineering, not a switch that makes a local prototype production-ready. ===== MILESTONES.md ===== # Delivery milestones · Readwise Estimated effort: **multi-day** for the indie phases; the production-only milestones add the trust and operability layer. ## M1 · Local foundation and data contract Create the runnable local foundation for a highlight importer with a review queue and source-linked exports, including the real schema and acceptance fixture. ### Steps 1. Create and start the local application Run the venv command first, then stop and activate it before running the remaining commands. Use your OS instructions: Windows .venv\Scripts\activate.bat in cmd, or .venv\Scripts\Activate.ps1 in PowerShell; macOS/Linux source .venv/bin/activate. Then install the listed packages. Create app.py exposing app, load .env with python-dotenv, and add a /healthz route. Freeze tested dependency versions to requirements.txt. Create .env manually from .env.example; replace SECRET_KEY before launch. Files: `app.py`, `requirements.txt`, `.env.example`, `.gitignore` ```sh python -m venv .venv python -m pip install Flask Flask-WTF python-dotenv waitress tzdata python -m pip freeze > requirements.txt python -m flask --app app run --host 127.0.0.1 ``` 2. Implement storage and seed the named fixture For database-backed state create schema.sql and db.py using this model: sources(id,title,author,source_url); highlights(id,source_id,text,location,import_hash); reviews(id,highlight_id,at,rating); schedules(highlight_id,due_date,interval_days); notes(id,highlight_id,text). Add the auxiliary relationships explicitly used in later phases; use stable ids, foreign keys, parameterized values and transactions. For canonical files use atomic replacement and hashes instead. Implement python manage.py init and python manage.py seed to create only synthetic data: A CSV with two book highlights and a repeated row, one due today and one tomorrow. Re-running init must not erase data. Files: `schema.sql`, `db.py`, `manage.py`, `fixtures/README.md` ```sh python manage.py init python manage.py seed ``` 3. Protect the local request boundary Install Flask-WTF CSRF protection for forms and same-origin fetches, validate Host and Origin against SITE_URL, bound inputs and escape output. Deliberately public intake endpoints get bounded validation and rate limits; signed provider webhooks use signature checks instead of browser CSRF tokens. All other admin routes stay local until product authentication exists. When a later phase tests viewer/member permissions, implement the users, hashed passwords, expiring server sessions and role checks in this foundation first; product mode must never use a fabricated identity from request input. Add error, empty, keyboard-focus and retry states now. Files: `app.py`, `templates/base.html`, `test/test_foundation.py` ### Done when - [ ] The documented start command serves /healthz and the initial screen at http://127.0.0.1:5000. - [ ] Restarting preserves the seeded records or canonical files; running init again deletes nothing. - [ ] A cross-origin state-changing request to an admin route is refused. ### Watch out - The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation. ## M2 · Import without duplicates Import without duplicates for Readwise: Preview CSV mapping for title, author, highlight and location; retain source provenance per highlight. ### Steps 1. Preview CSV mapping for title, author, highlight and location; retain source provenance per highlight. Preview CSV mapping for title, author, highlight and location; retain source provenance per highlight. Files: `features/import_without_duplicates.py`, `templates/import_without_duplicates.html` 2. Generate an import identity from source, location and normalized text and show repeated rows before commit. Generate an import identity from source, location and normalized text and show repeated rows before commit. Files: `features/import_without_duplicates.py` 3. Exercise the acceptance fixture Use A CSV with two book highlights and a repeated row, one due today and one tomorrow. Check: Importing the fixture twice leaves two highlights. Then check: A changed annotation is not discarded as a duplicate highlight. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Files: `test/test_import_without_duplicates.py` ```sh python -m unittest discover -s test ``` ### Done when - [ ] Importing the fixture twice leaves two highlights. - [ ] A changed annotation is not discarded as a duplicate highlight. ### Watch out - Source title alone cannot uniquely identify a book edition or web source. ## M3 · Deterministic review Deterministic review for Readwise: Build a due-today queue with again/good responses; define fixed interval rules in code and store every review event. ### Steps 1. Build a due-today queue with again/good responses; define fixed interval rules in code and store every review event. Build a due-today queue with again/good responses; define fixed interval rules in code and store every review event. Files: `features/deterministic_review.py`, `templates/deterministic_review.html` 2. Use the user-selected local date for scheduling and show the next due date before saving a response. Use the user-selected local date for scheduling and show the next due date before saving a response. Files: `features/deterministic_review.py` 3. Exercise the acceptance fixture Use A CSV with two book highlights and a repeated row, one due today and one tomorrow. Check: Again schedules tomorrow and Good doubles the previous interval according to the documented rule. Then check: Refreshing after answering does not submit a second review. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Files: `test/test_deterministic_review.py` ```sh python -m unittest discover -s test ``` ### Done when - [ ] Again schedules tomorrow and Good doubles the previous interval according to the documented rule. - [ ] Refreshing after answering does not submit a second review. ### Watch out - A simple review scheduler is not a claim to reproduce Readwise internal algorithms. ## M4 · Annotations and notes export Annotations and notes export for Readwise: Add personal notes and source filtering; preserve quoted text separately from commentary. ### Steps 1. Add personal notes and source filtering; preserve quoted text separately from commentary. Add personal notes and source filtering; preserve quoted text separately from commentary. Files: `features/annotations_and_notes_export.py`, `templates/annotations_and_notes_export.html` 2. Export Markdown grouped by source with locations and a JSON bundle containing schedules and history. Export Markdown grouped by source with locations and a JSON bundle containing schedules and history. Files: `features/annotations_and_notes_export.py` 3. Exercise the acceptance fixture Use A CSV with two book highlights and a repeated row, one due today and one tomorrow. Check: The Markdown export distinguishes the quote from the user note. Then check: Importing a backup restores the same due queue and review count. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Files: `test/test_annotations_and_notes_export.py` ```sh python -m unittest discover -s test ``` ### Done when - [ ] The Markdown export distinguishes the quote from the user note. - [ ] Importing a backup restores the same due queue and review count. ### Watch out - Do not promise Kindle or publisher integrations; use user-exported files first. ## M5 · Portable delivery and clean-start proof Finish the Readwise replacement with a documented first-run path and a recoverable export. ### Steps 1. Write the user-facing runbook Document prerequisites, every configuration variable, data locations and the three domain workflows: Import without duplicates; Deterministic review; Annotations and notes export. Include the exclusions, actual costs and source check date 2026-09-05. Commands shown earlier that reference project files are files the builder must implement before running them. Files: `README.md`, `.env.example` 2. Create and rehearse a recoverable backup Use sqlite3.Connection.backup for the database in DATA_DIR and pause writers while taking the matching attachment snapshot. Keep schema version, hashes and a manifest for readwise. Restore into a separate empty directory or isolated deployment, with all outbound actions and schedules disabled. Recreate this proof: A CSV with two book highlights and a repeated row, one due today and one tomorrow. Compare ids/counts and open the result before recording the restore date. Never test a restore over the only live copy. Files: `OPERATIONS.md`, `scripts/backup.py` 3. Reproduce the first-run experience Use a new folder and only README instructions to reach the fixture outcome. Install from requirements.txt, initialize storage, run the tests and exercise the UI at 375px and 1280px; use keyboard-only controls and inspect browser errors. Record exactly what passed; do not mark unrun checks complete. Files: `README.md`, `verification.md` ```sh python -m pip install -r requirements.txt python -m unittest discover -s test ``` ### Done when - [ ] A new folder reaches the documented fixture outcome using only README instructions. - [ ] A backup restored in isolation preserves the proof data and can be opened. ### Watch out - Export without an import or restore rehearsal is not verified portability. ## M6 · Operate and share with access controls (production only) Product-builder only: make a highlight importer with a review queue and source-linked exports operable for its stated audience before allowing remote access. ### Steps 1. Establish owner access before exposure Add owner/member/viewer authorization as appropriate, password hashes through Werkzeug, expiring server-side sessions, CSRF and login rate limits. Add users, sessions and audit schema migrations plus an owner-init command prompting securely for its password. Enforce ownership on every private read/write/download and fail closed when product setup is incomplete. Existing learner or admin identities must use this same boundary. Files: `ARCHITECTURE.md`, `OPERATIONS.md` 2. Deploy a monitored service Serve app:app with Waitress on loopback behind Caddy HTTPS. Configure trusted proxy headers narrowly, Secure/HttpOnly/SameSite cookies, upload limits, request ids and structured logs without private content. Run background jobs as a separate supervised process when the domain workflow requires them. Files: `Caddyfile`, `OPERATIONS.md` ```sh waitress-serve --listen=127.0.0.1:5000 app:app ``` 3. Rehearse loss and recovery Add a scheduled encrypted off-host backup using this procedure: Use sqlite3.Connection.backup for the database in DATA_DIR and pause writers while taking the matching attachment snapshot. Keep schema version, hashes and a manifest for readwise. Monitor health, disk space, failed jobs and backup age. Stop the service to test an alert; rehearse recovery with outbound effects disabled and record recovery time. Rotate any exposed credentials and require reconciliation before resuming queues. Files: `OPERATIONS.md`, `release-checklist.md` ### Done when - [ ] An unauthenticated visitor cannot read private records, download private files or mutate the admin surface. - [ ] A viewer cannot mutate data by making a direct request, and guessed ids cannot cross ownership boundaries. - [ ] Stopping the service triggers the configured alert and the latest off-host backup restores the fixture in isolation. ### Watch out - Product mode is additional engineering, not a switch that makes a local prototype production-ready. ===== OPERATIONS.md ===== # Operations · Readwise ## Backup Use sqlite3.Connection.backup for the database in DATA_DIR and pause writers while taking the matching attachment snapshot. Keep schema version, hashes and a manifest for readwise. ## Restore Restore into a separate empty directory or isolated deployment, with all outbound actions and schedules disabled. Recreate this proof: A CSV with two book highlights and a repeated row, one due today and one tomorrow. Compare ids/counts and open the result before recording the restore date. Never test a restore over the only live copy. Do a restore drill before the first real user, and write the date here when it passes. ## Monitoring Check HTTP availability, free disk, backup age and domain failures for Import without duplicates, Deterministic review, Annotations and notes export. Alert without logging private payloads. ## Incident checklist Pause outbound jobs and public intake as appropriate, preserve redacted diagnostics, restore an isolated verified backup, rotate affected credentials and reconcile uncertain effects before reopening. 1. Contain the issue without destroying evidence or user data. 2. Record the timeline and affected scope. 3. Rotate exposed secrets and revoke compromised sessions or credentials. 4. Restore from a verified backup when needed. 5. Document the root cause, the remediation and the regression test. ## Release gate - [ ] Importing the fixture twice leaves two highlights. - [ ] Again schedules tomorrow and Good doubles the previous interval according to the documented rule. - [ ] The Markdown export distinguishes the quote from the user note. - [ ] A private-data authorization check passes using a second identity. - [ ] An off-host restore drill has a date, observed result and recovery time in OPERATIONS.md. - [ ] README names the excluded vendor capabilities and actual provider/hosting costs. ## Launch constraint Do not market omitted Readwise capabilities as implemented. The non-goals in `PRODUCT.md` remain user-visible limitations until they are deliberately delivered. ===== .env.example ===== # Copy to .env and fill in. Never commit .env; this file documents it. # Required. A new private folder this application creates on first run; never serve it as static files. DATA_DIR=./data/readwise # Required · secret. Generate with python -c "import secrets; print(secrets.token_hex(32))" and save only in .env. SECRET_KEY=replace-with-a-random-secret # Required. Use indie for loopback-only personal work. Product mode must refuse to start until owner login and the deployment gates are configured. APP_MODE=indie # Required. The origin used for local forms and links; replace with the chosen HTTPS origin in product mode. SITE_URL=http://127.0.0.1:5000
README.md
# Readwise · indie build Build a highlight importer with a review queue and source-linked exports. Estimated effort: **multi-day**. Work `BUILD_PLAN.md` top to bottom · every phase ends in a check that has to pass before the next one starts. ## Stack | Part | Choice | Why | | --- | --- | --- | | Runtime | Python 3.12+ and Flask | A small local HTTP application with readable server-side handlers and no JavaScript build pipeline. | | Storage | SQLite through Python sqlite3 | Local ownership with explicit transactions and a portable backup path. | | Interface | Jinja HTML templates, CSS and vanilla JavaScript | Implement the specified screens directly with labelled controls and progressive enhancement. | | Verification | Python unittest and browser acceptance fixtures | Check invariants and the actual user workflow before the next phase. | ## Before you start Have every one of these ready. The plan assumes them from step one. - [ ] **Python 3.12 or newer and a terminal** · Python is free; this local prototype requires no hosting subscription. - Why: The local backend, tests and storage use Python. - Get it: Install Python from python.org. Open a terminal in a new empty project folder. On Windows, use py -3 where this guide says python if python is not on PATH; on macOS/Linux use python3 if needed. Create .venv and activate it before installing packages. - Verify: python --version reports 3.12+ and python -c "import sqlite3" succeeds. - [ ] **A current desktop browser and text editor** · No paid service required for this local step. - Why: You need to view the local interface and edit generated project files. - Get it: Use an installed Chrome, Firefox or Edge browser. Open the empty project folder in your editor; open the terminal there, not in this catalog repository. - Verify: You can create a text file in the project folder and open browser developer tools. - [ ] **Readwise acceptance sample** · No paid service required for this local step. - Why: This fixture makes the first end-to-end check reproducible. - Get it: Create synthetic sample data before implementation: A CSV with two book highlights and a repeated row, one due today and one tomorrow. Save it under fixtures/ with the expected results in fixtures/README.md; use no real credentials or customer records. - Verify: The fixture files and expected outcomes exist and can be inspected without a vendor account. - [ ] **Confirm the bounded replacement** · No paid service required for this local step. - Why: The full commercial product is larger than this guide. - Get it: The deliverable is a highlight importer with a review queue and source-linked exports. Read every exclusion below. Indie mode runs locally; any public or shared use requires the product access and deployment gates first. - Verify: You can name the primary workflow and the vendor features this version deliberately leaves out. ## Quick start ```sh python -m venv .venv python -m pip install Flask Flask-WTF python-dotenv waitress tzdata python -m pip freeze > requirements.txt python -m flask --app app run --host 127.0.0.1 ``` Then copy `.env.example` to `.env` and fill in the values it documents. ## Honest limits This build deliberately does not replace: - A simple review scheduler is not a claim to reproduce Readwise internal algorithms. - This is a highlight importer with a review queue and source-linked exports; full Readwise feature parity, vendor hosting and support are not included. - broad source integrations, sync, daily review polish, and knowledge-tool exports - publisher bypasses - cross-device mobile capture - high-quality recommendation graph - licensed full-text feeds If one of those is essential to you, that is the reason to keep paying for Readwise, and the README should say so rather than pretend.
BRIEF.md
# Build brief · Readwise The one-shot brief this plan expands. `BUILD_PLAN.md` (or `MILESTONES.md`) is the same sequence broken into steps and checks; where the two disagree, the plan wins. Build me a highlight importer with a review queue and source-linked exports as a bounded replacement for Readwise. Build it in phases in the order below. Do not write the whole product in one pass. Finish the current phase, run its Done when checks, fix failures, then continue. Indie mode completes Phases 1-5. Phase 6 is required before shared or public deployment. ### Stack (fixed, do not substitute) - Runtime: Python 3.12+ and Flask. A small local HTTP application with readable server-side handlers and no JavaScript build pipeline. - Storage: SQLite through Python sqlite3. Local ownership with explicit transactions and a portable backup path. - Interface: Jinja HTML templates, CSS and vanilla JavaScript. Implement the specified screens directly with labelled controls and progressive enhancement. - Verification: Python unittest and browser acceptance fixtures. Check invariants and the actual user workflow before the next phase. ### Data model (create this before Phase 1) - sources(id,title,author,source_url) - highlights(id,source_id,text,location,import_hash) - reviews(id,highlight_id,at,rating) - schedules(highlight_id,due_date,interval_days) - notes(id,highlight_id,text) - Use stable ids and explicit relationships; add auxiliary tables named by the phases before those phases use them. - Acceptance fixture: A CSV with two book highlights and a repeated row, one due today and one tomorrow. ### Prerequisites and configuration - Python 3.12 or newer and a terminal: Install Python from python.org. Open a terminal in a new empty project folder. On Windows, use py -3 where this guide says python if python is not on PATH; on macOS/Linux use python3 if needed. Create .venv and activate it before installing packages. Verify: python --version reports 3.12+ and python -c "import sqlite3" succeeds. Cost: Python is free; this local prototype requires no hosting subscription. - A current desktop browser and text editor: Use an installed Chrome, Firefox or Edge browser. Open the empty project folder in your editor; open the terminal there, not in this catalog repository. Verify: You can create a text file in the project folder and open browser developer tools. Cost: No paid service required for this local step. - Readwise acceptance sample: Create synthetic sample data before implementation: A CSV with two book highlights and a repeated row, one due today and one tomorrow. Save it under fixtures/ with the expected results in fixtures/README.md; use no real credentials or customer records. Verify: The fixture files and expected outcomes exist and can be inspected without a vendor account. Cost: No paid service required for this local step. - Confirm the bounded replacement: The deliverable is a highlight importer with a review queue and source-linked exports. Read every exclusion below. Indie mode runs locally; any public or shared use requires the product access and deployment gates first. Verify: You can name the primary workflow and the vendor features this version deliberately leaves out. Cost: No paid service required for this local step. - Configuration: DATA_DIR, SECRET_KEY, APP_MODE, SITE_URL. Ship .env.example, replace placeholders and exclude secrets from git. ### Phase 1 · Local foundation and data contract Build: Create the runnable local foundation for a highlight importer with a review queue and source-linked exports, including the real schema and acceptance fixture. - Run the venv command first, then stop and activate it before running the remaining commands. Use your OS instructions: Windows .venv\Scripts\activate.bat in cmd, or .venv\Scripts\Activate.ps1 in PowerShell; macOS/Linux source .venv/bin/activate. Then install the listed packages. Create app.py exposing app, load .env with python-dotenv, and add a /healthz route. Freeze tested dependency versions to requirements.txt. Create .env manually from .env.example; replace SECRET_KEY before launch. Commands, after creating the named files: `python -m venv .venv`; `python -m pip install Flask Flask-WTF python-dotenv waitress tzdata`; `python -m pip freeze > requirements.txt`; `python -m flask --app app run --host 127.0.0.1`. - For database-backed state create schema.sql and db.py using this model: sources(id,title,author,source_url); highlights(id,source_id,text,location,import_hash); reviews(id,highlight_id,at,rating); schedules(highlight_id,due_date,interval_days); notes(id,highlight_id,text). Add the auxiliary relationships explicitly used in later phases; use stable ids, foreign keys, parameterized values and transactions. For canonical files use atomic replacement and hashes instead. Implement python manage.py init and python manage.py seed to create only synthetic data: A CSV with two book highlights and a repeated row, one due today and one tomorrow. Re-running init must not erase data. Commands, after creating the named files: `python manage.py init`; `python manage.py seed`. - Install Flask-WTF CSRF protection for forms and same-origin fetches, validate Host and Origin against SITE_URL, bound inputs and escape output. Deliberately public intake endpoints get bounded validation and rate limits; signed provider webhooks use signature checks instead of browser CSRF tokens. All other admin routes stay local until product authentication exists. When a later phase tests viewer/member permissions, implement the users, hashed passwords, expiring server sessions and role checks in this foundation first; product mode must never use a fabricated identity from request input. Add error, empty, keyboard-focus and retry states now. - Trap: The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation. Done when: The documented start command serves /healthz and the initial screen at http://127.0.0.1:5000. Restarting preserves the seeded records or canonical files; running init again deletes nothing. A cross-origin state-changing request to an admin route is refused. Do not build yet: Do not start import without duplicates until these checks pass. ### Phase 2 · Import without duplicates Build: Import without duplicates for Readwise: Preview CSV mapping for title, author, highlight and location; retain source provenance per highlight. - Preview CSV mapping for title, author, highlight and location; retain source provenance per highlight. - Generate an import identity from source, location and normalized text and show repeated rows before commit. - Use A CSV with two book highlights and a repeated row, one due today and one tomorrow. Check: Importing the fixture twice leaves two highlights. Then check: A changed annotation is not discarded as a duplicate highlight. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Commands, after creating the named files: `python -m unittest discover -s test`. - Trap: Source title alone cannot uniquely identify a book edition or web source. Done when: Importing the fixture twice leaves two highlights. A changed annotation is not discarded as a duplicate highlight. Do not build yet: Do not start deterministic review until these checks pass. ### Phase 3 · Deterministic review Build: Deterministic review for Readwise: Build a due-today queue with again/good responses; define fixed interval rules in code and store every review event. - Build a due-today queue with again/good responses; define fixed interval rules in code and store every review event. - Use the user-selected local date for scheduling and show the next due date before saving a response. - Use A CSV with two book highlights and a repeated row, one due today and one tomorrow. Check: Again schedules tomorrow and Good doubles the previous interval according to the documented rule. Then check: Refreshing after answering does not submit a second review. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Commands, after creating the named files: `python -m unittest discover -s test`. - Trap: A simple review scheduler is not a claim to reproduce Readwise internal algorithms. Done when: Again schedules tomorrow and Good doubles the previous interval according to the documented rule. Refreshing after answering does not submit a second review. Do not build yet: Do not start annotations and notes export until these checks pass. ### Phase 4 · Annotations and notes export Build: Annotations and notes export for Readwise: Add personal notes and source filtering; preserve quoted text separately from commentary. - Add personal notes and source filtering; preserve quoted text separately from commentary. - Export Markdown grouped by source with locations and a JSON bundle containing schedules and history. - Use A CSV with two book highlights and a repeated row, one due today and one tomorrow. Check: The Markdown export distinguishes the quote from the user note. Then check: Importing a backup restores the same due queue and review count. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Commands, after creating the named files: `python -m unittest discover -s test`. - Trap: Do not promise Kindle or publisher integrations; use user-exported files first. Done when: The Markdown export distinguishes the quote from the user note. Importing a backup restores the same due queue and review count. Do not build yet: Do not start portable delivery and clean-start proof until these checks pass. ### Phase 5 · Portable delivery and clean-start proof Build: Finish the Readwise replacement with a documented first-run path and a recoverable export. - Document prerequisites, every configuration variable, data locations and the three domain workflows: Import without duplicates; Deterministic review; Annotations and notes export. Include the exclusions, actual costs and source check date 2026-09-05. Commands shown earlier that reference project files are files the builder must implement before running them. - Use sqlite3.Connection.backup for the database in DATA_DIR and pause writers while taking the matching attachment snapshot. Keep schema version, hashes and a manifest for readwise. Restore into a separate empty directory or isolated deployment, with all outbound actions and schedules disabled. Recreate this proof: A CSV with two book highlights and a repeated row, one due today and one tomorrow. Compare ids/counts and open the result before recording the restore date. Never test a restore over the only live copy. - Use a new folder and only README instructions to reach the fixture outcome. Install from requirements.txt, initialize storage, run the tests and exercise the UI at 375px and 1280px; use keyboard-only controls and inspect browser errors. Record exactly what passed; do not mark unrun checks complete. Commands, after creating the named files: `python -m pip install -r requirements.txt`; `python -m unittest discover -s test`. - Trap: Export without an import or restore rehearsal is not verified portability. Done when: A new folder reaches the documented fixture outcome using only README instructions. A backup restored in isolation preserves the proof data and can be opened. Do not build yet: Do not start operate and share with access controls until these checks pass. ### Phase 6 · Operate and share with access controls (product-builder only) Build: Product-builder only: make a highlight importer with a review queue and source-linked exports operable for its stated audience before allowing remote access. - Add owner/member/viewer authorization as appropriate, password hashes through Werkzeug, expiring server-side sessions, CSRF and login rate limits. Add users, sessions and audit schema migrations plus an owner-init command prompting securely for its password. Enforce ownership on every private read/write/download and fail closed when product setup is incomplete. Existing learner or admin identities must use this same boundary. - Serve app:app with Waitress on loopback behind Caddy HTTPS. Configure trusted proxy headers narrowly, Secure/HttpOnly/SameSite cookies, upload limits, request ids and structured logs without private content. Run background jobs as a separate supervised process when the domain workflow requires them. Commands, after creating the named files: `waitress-serve --listen=127.0.0.1:5000 app:app`. - Add a scheduled encrypted off-host backup using this procedure: Use sqlite3.Connection.backup for the database in DATA_DIR and pause writers while taking the matching attachment snapshot. Keep schema version, hashes and a manifest for readwise. Monitor health, disk space, failed jobs and backup age. Stop the service to test an alert; rehearse recovery with outbound effects disabled and record recovery time. Rotate any exposed credentials and require reconciliation before resuming queues. - Trap: Product mode is additional engineering, not a switch that makes a local prototype production-ready. Done when: An unauthenticated visitor cannot read private records, download private files or mutate the admin surface. A viewer cannot mutate data by making a direct request, and guessed ids cannot cross ownership boundaries. Stopping the service triggers the configured alert and the latest off-host backup restores the fixture in isolation. Do not build yet: Do not add new providers or vendor-scale features until the release gates are recorded. ### Out of scope (and why) - A simple review scheduler is not a claim to reproduce Readwise internal algorithms. - This is a highlight importer with a review queue and source-linked exports; full Readwise feature parity, vendor hosting and support are not included. - broad source integrations, sync, daily review polish, and knowledge-tool exports: retain the paid product if this capability is essential; it is outside this bounded build. - publisher bypasses: retain the paid product if this capability is essential; it is outside this bounded build. - cross-device mobile capture: retain the paid product if this capability is essential; it is outside this bounded build. - high-quality recommendation graph: retain the paid product if this capability is essential; it is outside this bounded build. - licensed full-text feeds: retain the paid product if this capability is essential; it is outside this bounded build. ### README must contain - Exact install, configure, initialize, start, test and recovery commands for a clean folder. - The schema, fixture, acceptance results, private data locations and export format. - Every prerequisite and secret source, actual running costs and deliberately excluded capabilities. - An honest distinction between tests actually run and checks still awaiting real credentials or deployment. - Dependency documentation reviewed 2026-09-05: https://flask.palletsprojects.com/en/stable/installation/ ; https://docs.python.org/3/library/sqlite3.html ; https://flask-wtf.readthedocs.io/en/1.2.x/csrf/ ; https://docs.pylonsproject.org/projects/waitress/en/stable/usage.html. Recheck before upgrading; freeze the versions actually tested.
AGENTS.md
# Agent instructions · Readwise indie build - Read `README.md` and `BUILD_PLAN.md` before writing code. The stack is fixed: Python 3.12+ and Flask, SQLite through Python sqlite3, Jinja HTML templates, CSS and vanilla JavaScript, Python unittest and browser acceptance fixtures. Do not substitute. - Work one phase at a time, in order. Do not start a phase until every "Done when" item of the previous one passes. - Prefer the fewest moving parts that satisfy the step. No frameworks, services or dependencies the plan does not name. - Secrets live in `.env`, never in source or logs. Keep `.env.example` current when a variable is introduced. - Do not invent cryptography, security guarantees, APIs or compliance claims. - Add a focused test for every destructive, security-sensitive or data-loss path the plan names. - Run the project checks before declaring a phase complete, and record any deliberate shortcut in the README under "Tradeoffs". ## Known traps - The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation. - Source title alone cannot uniquely identify a book edition or web source. - A simple review scheduler is not a claim to reproduce Readwise internal algorithms. - Do not promise Kindle or publisher integrations; use user-exported files first. - Export without an import or restore rehearsal is not verified portability.
BUILD_PLAN.md
# Build plan · Readwise Build a highlight importer with a review queue and source-linked exports. Phases are in dependency order. Each ends in a "Done when" list; treat an unticked item as a blocker, not a note. ## Phase 1 · Local foundation and data contract Create the runnable local foundation for a highlight importer with a review queue and source-linked exports, including the real schema and acceptance fixture. ### Steps 1. Create and start the local application Run the venv command first, then stop and activate it before running the remaining commands. Use your OS instructions: Windows .venv\Scripts\activate.bat in cmd, or .venv\Scripts\Activate.ps1 in PowerShell; macOS/Linux source .venv/bin/activate. Then install the listed packages. Create app.py exposing app, load .env with python-dotenv, and add a /healthz route. Freeze tested dependency versions to requirements.txt. Create .env manually from .env.example; replace SECRET_KEY before launch. Files: `app.py`, `requirements.txt`, `.env.example`, `.gitignore` ```sh python -m venv .venv python -m pip install Flask Flask-WTF python-dotenv waitress tzdata python -m pip freeze > requirements.txt python -m flask --app app run --host 127.0.0.1 ``` 2. Implement storage and seed the named fixture For database-backed state create schema.sql and db.py using this model: sources(id,title,author,source_url); highlights(id,source_id,text,location,import_hash); reviews(id,highlight_id,at,rating); schedules(highlight_id,due_date,interval_days); notes(id,highlight_id,text). Add the auxiliary relationships explicitly used in later phases; use stable ids, foreign keys, parameterized values and transactions. For canonical files use atomic replacement and hashes instead. Implement python manage.py init and python manage.py seed to create only synthetic data: A CSV with two book highlights and a repeated row, one due today and one tomorrow. Re-running init must not erase data. Files: `schema.sql`, `db.py`, `manage.py`, `fixtures/README.md` ```sh python manage.py init python manage.py seed ``` 3. Protect the local request boundary Install Flask-WTF CSRF protection for forms and same-origin fetches, validate Host and Origin against SITE_URL, bound inputs and escape output. Deliberately public intake endpoints get bounded validation and rate limits; signed provider webhooks use signature checks instead of browser CSRF tokens. All other admin routes stay local until product authentication exists. When a later phase tests viewer/member permissions, implement the users, hashed passwords, expiring server sessions and role checks in this foundation first; product mode must never use a fabricated identity from request input. Add error, empty, keyboard-focus and retry states now. Files: `app.py`, `templates/base.html`, `test/test_foundation.py` ### Done when - [ ] The documented start command serves /healthz and the initial screen at http://127.0.0.1:5000. - [ ] Restarting preserves the seeded records or canonical files; running init again deletes nothing. - [ ] A cross-origin state-changing request to an admin route is refused. ### Watch out - The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation. ## Phase 2 · Import without duplicates Import without duplicates for Readwise: Preview CSV mapping for title, author, highlight and location; retain source provenance per highlight. ### Steps 1. Preview CSV mapping for title, author, highlight and location; retain source provenance per highlight. Preview CSV mapping for title, author, highlight and location; retain source provenance per highlight. Files: `features/import_without_duplicates.py`, `templates/import_without_duplicates.html` 2. Generate an import identity from source, location and normalized text and show repeated rows before commit. Generate an import identity from source, location and normalized text and show repeated rows before commit. Files: `features/import_without_duplicates.py` 3. Exercise the acceptance fixture Use A CSV with two book highlights and a repeated row, one due today and one tomorrow. Check: Importing the fixture twice leaves two highlights. Then check: A changed annotation is not discarded as a duplicate highlight. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Files: `test/test_import_without_duplicates.py` ```sh python -m unittest discover -s test ``` ### Done when - [ ] Importing the fixture twice leaves two highlights. - [ ] A changed annotation is not discarded as a duplicate highlight. ### Watch out - Source title alone cannot uniquely identify a book edition or web source. ## Phase 3 · Deterministic review Deterministic review for Readwise: Build a due-today queue with again/good responses; define fixed interval rules in code and store every review event. ### Steps 1. Build a due-today queue with again/good responses; define fixed interval rules in code and store every review event. Build a due-today queue with again/good responses; define fixed interval rules in code and store every review event. Files: `features/deterministic_review.py`, `templates/deterministic_review.html` 2. Use the user-selected local date for scheduling and show the next due date before saving a response. Use the user-selected local date for scheduling and show the next due date before saving a response. Files: `features/deterministic_review.py` 3. Exercise the acceptance fixture Use A CSV with two book highlights and a repeated row, one due today and one tomorrow. Check: Again schedules tomorrow and Good doubles the previous interval according to the documented rule. Then check: Refreshing after answering does not submit a second review. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Files: `test/test_deterministic_review.py` ```sh python -m unittest discover -s test ``` ### Done when - [ ] Again schedules tomorrow and Good doubles the previous interval according to the documented rule. - [ ] Refreshing after answering does not submit a second review. ### Watch out - A simple review scheduler is not a claim to reproduce Readwise internal algorithms. ## Phase 4 · Annotations and notes export Annotations and notes export for Readwise: Add personal notes and source filtering; preserve quoted text separately from commentary. ### Steps 1. Add personal notes and source filtering; preserve quoted text separately from commentary. Add personal notes and source filtering; preserve quoted text separately from commentary. Files: `features/annotations_and_notes_export.py`, `templates/annotations_and_notes_export.html` 2. Export Markdown grouped by source with locations and a JSON bundle containing schedules and history. Export Markdown grouped by source with locations and a JSON bundle containing schedules and history. Files: `features/annotations_and_notes_export.py` 3. Exercise the acceptance fixture Use A CSV with two book highlights and a repeated row, one due today and one tomorrow. Check: The Markdown export distinguishes the quote from the user note. Then check: Importing a backup restores the same due queue and review count. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Files: `test/test_annotations_and_notes_export.py` ```sh python -m unittest discover -s test ``` ### Done when - [ ] The Markdown export distinguishes the quote from the user note. - [ ] Importing a backup restores the same due queue and review count. ### Watch out - Do not promise Kindle or publisher integrations; use user-exported files first. ## Phase 5 · Portable delivery and clean-start proof Finish the Readwise replacement with a documented first-run path and a recoverable export. ### Steps 1. Write the user-facing runbook Document prerequisites, every configuration variable, data locations and the three domain workflows: Import without duplicates; Deterministic review; Annotations and notes export. Include the exclusions, actual costs and source check date 2026-09-05. Commands shown earlier that reference project files are files the builder must implement before running them. Files: `README.md`, `.env.example` 2. Create and rehearse a recoverable backup Use sqlite3.Connection.backup for the database in DATA_DIR and pause writers while taking the matching attachment snapshot. Keep schema version, hashes and a manifest for readwise. Restore into a separate empty directory or isolated deployment, with all outbound actions and schedules disabled. Recreate this proof: A CSV with two book highlights and a repeated row, one due today and one tomorrow. Compare ids/counts and open the result before recording the restore date. Never test a restore over the only live copy. Files: `OPERATIONS.md`, `scripts/backup.py` 3. Reproduce the first-run experience Use a new folder and only README instructions to reach the fixture outcome. Install from requirements.txt, initialize storage, run the tests and exercise the UI at 375px and 1280px; use keyboard-only controls and inspect browser errors. Record exactly what passed; do not mark unrun checks complete. Files: `README.md`, `verification.md` ```sh python -m pip install -r requirements.txt python -m unittest discover -s test ``` ### Done when - [ ] A new folder reaches the documented fixture outcome using only README instructions. - [ ] A backup restored in isolation preserves the proof data and can be opened. ### Watch out - Export without an import or restore rehearsal is not verified portability. ## Not in this build - A simple review scheduler is not a claim to reproduce Readwise internal algorithms. - This is a highlight importer with a review queue and source-linked exports; full Readwise feature parity, vendor hosting and support are not included. - broad source integrations, sync, daily review polish, and knowledge-tool exports - publisher bypasses - cross-device mobile capture - high-quality recommendation graph - licensed full-text feeds ## After v1, if you want it - Extend annotations and notes export only after the fixture and recovery checks pass. - Before adding another integration, document its credentials, limits, cost and failure behavior with primary-source links.
.env.example
# Copy to .env and fill in. Never commit .env; this file documents it. # Required. A new private folder this application creates on first run; never serve it as static files. DATA_DIR=./data/readwise # Required · secret. Generate with python -c "import secrets; print(secrets.token_hex(32))" and save only in .env. SECRET_KEY=replace-with-a-random-secret # Required. Use indie for loopback-only personal work. Product mode must refuse to start until owner login and the deployment gates are configured. APP_MODE=indie # Required. The origin used for local forms and links; replace with the chosen HTTPS origin in product mode. SITE_URL=http://127.0.0.1:5000
PRODUCT.md
# Readwise · product brief ## Problem The core loop is buildable, but a dependable replacement becomes a real weekend or multi-day project. For Readwise, import highlights from user-exported files, review them with spaced repetition, and export notes. The hard boundary is broad source integrations, sync, daily review polish, and knowledge-tool exports, plus capture polish, sync, and content partnerships. ## Product outcome An operated version of a highlight importer with a review queue and source-linked exports, with authorized access, restore evidence and honest scope limits. ## Target user A builder who needs a maintainable product foundation, not a one-off demo. ## Required capabilities - Node.js 22 - local disk - optional browser bookmarklet - user-supplied RSS feeds ## Explicit non-goals for v1 - A simple review scheduler is not a claim to reproduce Readwise internal algorithms. - This is a highlight importer with a review queue and source-linked exports; full Readwise feature parity, vendor hosting and support are not included. - broad source integrations, sync, daily review polish, and knowledge-tool exports - publisher bypasses - cross-device mobile capture - high-quality recommendation graph - licensed full-text feeds ## Success criteria - Importing the fixture twice leaves two highlights. - Again schedules tomorrow and Good doubles the previous interval according to the documented rule. - The Markdown export distinguishes the quote from the user note. - A private-data authorization check passes using a second identity. - An off-host restore drill has a date, observed result and recovery time in OPERATIONS.md. - README names the excluded vendor capabilities and actual provider/hosting costs.
BRIEF.md
# Build brief · Readwise The one-shot brief this plan expands. `BUILD_PLAN.md` (or `MILESTONES.md`) is the same sequence broken into steps and checks; where the two disagree, the plan wins. Build me a highlight importer with a review queue and source-linked exports as a bounded replacement for Readwise. Build it in phases in the order below. Do not write the whole product in one pass. Finish the current phase, run its Done when checks, fix failures, then continue. Indie mode completes Phases 1-5. Phase 6 is required before shared or public deployment. ### Stack (fixed, do not substitute) - Runtime: Python 3.12+ and Flask. A small local HTTP application with readable server-side handlers and no JavaScript build pipeline. - Storage: SQLite through Python sqlite3. Local ownership with explicit transactions and a portable backup path. - Interface: Jinja HTML templates, CSS and vanilla JavaScript. Implement the specified screens directly with labelled controls and progressive enhancement. - Verification: Python unittest and browser acceptance fixtures. Check invariants and the actual user workflow before the next phase. ### Data model (create this before Phase 1) - sources(id,title,author,source_url) - highlights(id,source_id,text,location,import_hash) - reviews(id,highlight_id,at,rating) - schedules(highlight_id,due_date,interval_days) - notes(id,highlight_id,text) - Use stable ids and explicit relationships; add auxiliary tables named by the phases before those phases use them. - Acceptance fixture: A CSV with two book highlights and a repeated row, one due today and one tomorrow. ### Prerequisites and configuration - Python 3.12 or newer and a terminal: Install Python from python.org. Open a terminal in a new empty project folder. On Windows, use py -3 where this guide says python if python is not on PATH; on macOS/Linux use python3 if needed. Create .venv and activate it before installing packages. Verify: python --version reports 3.12+ and python -c "import sqlite3" succeeds. Cost: Python is free; this local prototype requires no hosting subscription. - A current desktop browser and text editor: Use an installed Chrome, Firefox or Edge browser. Open the empty project folder in your editor; open the terminal there, not in this catalog repository. Verify: You can create a text file in the project folder and open browser developer tools. Cost: No paid service required for this local step. - Readwise acceptance sample: Create synthetic sample data before implementation: A CSV with two book highlights and a repeated row, one due today and one tomorrow. Save it under fixtures/ with the expected results in fixtures/README.md; use no real credentials or customer records. Verify: The fixture files and expected outcomes exist and can be inspected without a vendor account. Cost: No paid service required for this local step. - Confirm the bounded replacement: The deliverable is a highlight importer with a review queue and source-linked exports. Read every exclusion below. Indie mode runs locally; any public or shared use requires the product access and deployment gates first. Verify: You can name the primary workflow and the vendor features this version deliberately leaves out. Cost: No paid service required for this local step. - Configuration: DATA_DIR, SECRET_KEY, APP_MODE, SITE_URL. Ship .env.example, replace placeholders and exclude secrets from git. ### Phase 1 · Local foundation and data contract Build: Create the runnable local foundation for a highlight importer with a review queue and source-linked exports, including the real schema and acceptance fixture. - Run the venv command first, then stop and activate it before running the remaining commands. Use your OS instructions: Windows .venv\Scripts\activate.bat in cmd, or .venv\Scripts\Activate.ps1 in PowerShell; macOS/Linux source .venv/bin/activate. Then install the listed packages. Create app.py exposing app, load .env with python-dotenv, and add a /healthz route. Freeze tested dependency versions to requirements.txt. Create .env manually from .env.example; replace SECRET_KEY before launch. Commands, after creating the named files: `python -m venv .venv`; `python -m pip install Flask Flask-WTF python-dotenv waitress tzdata`; `python -m pip freeze > requirements.txt`; `python -m flask --app app run --host 127.0.0.1`. - For database-backed state create schema.sql and db.py using this model: sources(id,title,author,source_url); highlights(id,source_id,text,location,import_hash); reviews(id,highlight_id,at,rating); schedules(highlight_id,due_date,interval_days); notes(id,highlight_id,text). Add the auxiliary relationships explicitly used in later phases; use stable ids, foreign keys, parameterized values and transactions. For canonical files use atomic replacement and hashes instead. Implement python manage.py init and python manage.py seed to create only synthetic data: A CSV with two book highlights and a repeated row, one due today and one tomorrow. Re-running init must not erase data. Commands, after creating the named files: `python manage.py init`; `python manage.py seed`. - Install Flask-WTF CSRF protection for forms and same-origin fetches, validate Host and Origin against SITE_URL, bound inputs and escape output. Deliberately public intake endpoints get bounded validation and rate limits; signed provider webhooks use signature checks instead of browser CSRF tokens. All other admin routes stay local until product authentication exists. When a later phase tests viewer/member permissions, implement the users, hashed passwords, expiring server sessions and role checks in this foundation first; product mode must never use a fabricated identity from request input. Add error, empty, keyboard-focus and retry states now. - Trap: The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation. Done when: The documented start command serves /healthz and the initial screen at http://127.0.0.1:5000. Restarting preserves the seeded records or canonical files; running init again deletes nothing. A cross-origin state-changing request to an admin route is refused. Do not build yet: Do not start import without duplicates until these checks pass. ### Phase 2 · Import without duplicates Build: Import without duplicates for Readwise: Preview CSV mapping for title, author, highlight and location; retain source provenance per highlight. - Preview CSV mapping for title, author, highlight and location; retain source provenance per highlight. - Generate an import identity from source, location and normalized text and show repeated rows before commit. - Use A CSV with two book highlights and a repeated row, one due today and one tomorrow. Check: Importing the fixture twice leaves two highlights. Then check: A changed annotation is not discarded as a duplicate highlight. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Commands, after creating the named files: `python -m unittest discover -s test`. - Trap: Source title alone cannot uniquely identify a book edition or web source. Done when: Importing the fixture twice leaves two highlights. A changed annotation is not discarded as a duplicate highlight. Do not build yet: Do not start deterministic review until these checks pass. ### Phase 3 · Deterministic review Build: Deterministic review for Readwise: Build a due-today queue with again/good responses; define fixed interval rules in code and store every review event. - Build a due-today queue with again/good responses; define fixed interval rules in code and store every review event. - Use the user-selected local date for scheduling and show the next due date before saving a response. - Use A CSV with two book highlights and a repeated row, one due today and one tomorrow. Check: Again schedules tomorrow and Good doubles the previous interval according to the documented rule. Then check: Refreshing after answering does not submit a second review. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Commands, after creating the named files: `python -m unittest discover -s test`. - Trap: A simple review scheduler is not a claim to reproduce Readwise internal algorithms. Done when: Again schedules tomorrow and Good doubles the previous interval according to the documented rule. Refreshing after answering does not submit a second review. Do not build yet: Do not start annotations and notes export until these checks pass. ### Phase 4 · Annotations and notes export Build: Annotations and notes export for Readwise: Add personal notes and source filtering; preserve quoted text separately from commentary. - Add personal notes and source filtering; preserve quoted text separately from commentary. - Export Markdown grouped by source with locations and a JSON bundle containing schedules and history. - Use A CSV with two book highlights and a repeated row, one due today and one tomorrow. Check: The Markdown export distinguishes the quote from the user note. Then check: Importing a backup restores the same due queue and review count. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Commands, after creating the named files: `python -m unittest discover -s test`. - Trap: Do not promise Kindle or publisher integrations; use user-exported files first. Done when: The Markdown export distinguishes the quote from the user note. Importing a backup restores the same due queue and review count. Do not build yet: Do not start portable delivery and clean-start proof until these checks pass. ### Phase 5 · Portable delivery and clean-start proof Build: Finish the Readwise replacement with a documented first-run path and a recoverable export. - Document prerequisites, every configuration variable, data locations and the three domain workflows: Import without duplicates; Deterministic review; Annotations and notes export. Include the exclusions, actual costs and source check date 2026-09-05. Commands shown earlier that reference project files are files the builder must implement before running them. - Use sqlite3.Connection.backup for the database in DATA_DIR and pause writers while taking the matching attachment snapshot. Keep schema version, hashes and a manifest for readwise. Restore into a separate empty directory or isolated deployment, with all outbound actions and schedules disabled. Recreate this proof: A CSV with two book highlights and a repeated row, one due today and one tomorrow. Compare ids/counts and open the result before recording the restore date. Never test a restore over the only live copy. - Use a new folder and only README instructions to reach the fixture outcome. Install from requirements.txt, initialize storage, run the tests and exercise the UI at 375px and 1280px; use keyboard-only controls and inspect browser errors. Record exactly what passed; do not mark unrun checks complete. Commands, after creating the named files: `python -m pip install -r requirements.txt`; `python -m unittest discover -s test`. - Trap: Export without an import or restore rehearsal is not verified portability. Done when: A new folder reaches the documented fixture outcome using only README instructions. A backup restored in isolation preserves the proof data and can be opened. Do not build yet: Do not start operate and share with access controls until these checks pass. ### Phase 6 · Operate and share with access controls (product-builder only) Build: Product-builder only: make a highlight importer with a review queue and source-linked exports operable for its stated audience before allowing remote access. - Add owner/member/viewer authorization as appropriate, password hashes through Werkzeug, expiring server-side sessions, CSRF and login rate limits. Add users, sessions and audit schema migrations plus an owner-init command prompting securely for its password. Enforce ownership on every private read/write/download and fail closed when product setup is incomplete. Existing learner or admin identities must use this same boundary. - Serve app:app with Waitress on loopback behind Caddy HTTPS. Configure trusted proxy headers narrowly, Secure/HttpOnly/SameSite cookies, upload limits, request ids and structured logs without private content. Run background jobs as a separate supervised process when the domain workflow requires them. Commands, after creating the named files: `waitress-serve --listen=127.0.0.1:5000 app:app`. - Add a scheduled encrypted off-host backup using this procedure: Use sqlite3.Connection.backup for the database in DATA_DIR and pause writers while taking the matching attachment snapshot. Keep schema version, hashes and a manifest for readwise. Monitor health, disk space, failed jobs and backup age. Stop the service to test an alert; rehearse recovery with outbound effects disabled and record recovery time. Rotate any exposed credentials and require reconciliation before resuming queues. - Trap: Product mode is additional engineering, not a switch that makes a local prototype production-ready. Done when: An unauthenticated visitor cannot read private records, download private files or mutate the admin surface. A viewer cannot mutate data by making a direct request, and guessed ids cannot cross ownership boundaries. Stopping the service triggers the configured alert and the latest off-host backup restores the fixture in isolation. Do not build yet: Do not add new providers or vendor-scale features until the release gates are recorded. ### Out of scope (and why) - A simple review scheduler is not a claim to reproduce Readwise internal algorithms. - This is a highlight importer with a review queue and source-linked exports; full Readwise feature parity, vendor hosting and support are not included. - broad source integrations, sync, daily review polish, and knowledge-tool exports: retain the paid product if this capability is essential; it is outside this bounded build. - publisher bypasses: retain the paid product if this capability is essential; it is outside this bounded build. - cross-device mobile capture: retain the paid product if this capability is essential; it is outside this bounded build. - high-quality recommendation graph: retain the paid product if this capability is essential; it is outside this bounded build. - licensed full-text feeds: retain the paid product if this capability is essential; it is outside this bounded build. ### README must contain - Exact install, configure, initialize, start, test and recovery commands for a clean folder. - The schema, fixture, acceptance results, private data locations and export format. - Every prerequisite and secret source, actual running costs and deliberately excluded capabilities. - An honest distinction between tests actually run and checks still awaiting real credentials or deployment. - Dependency documentation reviewed 2026-09-05: https://flask.palletsprojects.com/en/stable/installation/ ; https://docs.python.org/3/library/sqlite3.html ; https://flask-wtf.readthedocs.io/en/1.2.x/csrf/ ; https://docs.pylonsproject.org/projects/waitress/en/stable/usage.html. Recheck before upgrading; freeze the versions actually tested.
ARCHITECTURE.md
# Architecture · Readwise ## Stack | Part | Choice | Why | | --- | --- | --- | | Runtime | Python 3.12+ and Flask | A small local HTTP application with readable server-side handlers and no JavaScript build pipeline. | | Storage | SQLite through Python sqlite3 | Local ownership with explicit transactions and a portable backup path. | | Interface | Jinja HTML templates, CSS and vanilla JavaScript | Implement the specified screens directly with labelled controls and progressive enhancement. | | Verification | Python unittest and browser acceptance fixtures | Check invariants and the actual user workflow before the next phase. | ## Modules Each module has one owner concern and a documented way to replace it. | Module | Owns | How to replace it | | --- | --- | --- | | Data and identity | sources(id,title,author,source_url); highlights(id,source_id,text,location,import_hash); reviews(id,highlight_id,at,rating); schedules(highlight_id,due_date,interval_days); notes(id,highlight_id,text) | Keep stable ids and a versioned repository interface; migrate storage behind it with a fixture round-trip. | | Import without duplicates | Preview CSV mapping for title, author, highlight and location; retain source provenance per highlight. | Keep the acceptance contract: Importing the fixture twice leaves two highlights. Replace only this module after replaying its fixture; preserve ids and existing records. | | Deterministic review | Build a due-today queue with again/good responses; define fixed interval rules in code and store every review event. | Keep the acceptance contract: Again schedules tomorrow and Good doubles the previous interval according to the documented rule. Replace only this module after replaying its fixture; preserve ids and existing records. | | Annotations and notes export | Add personal notes and source filtering; preserve quoted text separately from commentary. | Keep the acceptance contract: The Markdown export distinguishes the quote from the user note. Replace only this module after replaying its fixture; preserve ids and existing records. | | Operations | Use sqlite3.Connection.backup for the database in DATA_DIR and pause writers while taking the matching attachment snapshot. Keep schema version, hashes and a manifest for readwise. | Change host or backup destination only after an isolated restore and authorization check. | ## Configuration Every runtime setting is an environment variable documented in `.env.example`, validated at startup, with a safe local default wherever one exists. - `DATA_DIR` · required · A new private folder this application creates on first run; never serve it as static files. - `SECRET_KEY` · required, secret · Generate with python -c "import secrets; print(secrets.token_hex(32))" and save only in .env. - `APP_MODE` · required · Use indie for loopback-only personal work. Product mode must refuse to start until owner login and the deployment gates are configured. - `SITE_URL` · required · The origin used for local forms and links; replace with the chosen HTTPS origin in product mode. ## Production baseline - Security: least privilege, input validation at every boundary, secret redaction in logs, rate limits on abuse-prone paths, no invented security primitives. - Data: explicit schema and migrations, transactional writes where integrity matters, backup and restore procedures that have been exercised. - Integrations: adapters around third-party providers, idempotent webhook or job processing, bounded retries, timeouts. - Observability: structured logs with request or operation ids, an error-tracking hook, and health and readiness checks where a server exists. - Quality: unit tests for domain rules, integration tests at module boundaries, one end-to-end test of the critical path. ## Decision records For each dependency in the stack table, keep a short note: why it was chosen, its failure mode, and how it is replaced. Do not add infrastructure until a requirement in `PRODUCT.md` justifies it.
AGENTS.md
# Agent instructions · Readwise product build - Read `PRODUCT.md` and `ARCHITECTURE.md` before changing code. The stack is fixed: Python 3.12+ and Flask, SQLite through Python sqlite3, Jinja HTML templates, CSS and vanilla JavaScript, Python unittest and browser acceptance fixtures. - Implement milestone by milestone from `MILESTONES.md`; keep each change reviewable and leave the application runnable at every commit. - Treat authentication, payments, encryption, imports, webhooks and destructive actions as high-risk boundaries when present. - Never invent cryptography or silently weaken a requirement to make a check pass. - Put every external service behind an interface with a deterministic fake for tests. - Add migrations and rollback or recovery notes for every persistent data change. - Log useful operational context without credentials, tokens, passwords or personal data. - Update documentation and run every check before completing a milestone. ## Known traps - The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation. - Source title alone cannot uniquely identify a book edition or web source. - A simple review scheduler is not a claim to reproduce Readwise internal algorithms. - Do not promise Kindle or publisher integrations; use user-exported files first. - Export without an import or restore rehearsal is not verified portability. - Product mode is additional engineering, not a switch that makes a local prototype production-ready.
MILESTONES.md
# Delivery milestones · Readwise Estimated effort: **multi-day** for the indie phases; the production-only milestones add the trust and operability layer. ## M1 · Local foundation and data contract Create the runnable local foundation for a highlight importer with a review queue and source-linked exports, including the real schema and acceptance fixture. ### Steps 1. Create and start the local application Run the venv command first, then stop and activate it before running the remaining commands. Use your OS instructions: Windows .venv\Scripts\activate.bat in cmd, or .venv\Scripts\Activate.ps1 in PowerShell; macOS/Linux source .venv/bin/activate. Then install the listed packages. Create app.py exposing app, load .env with python-dotenv, and add a /healthz route. Freeze tested dependency versions to requirements.txt. Create .env manually from .env.example; replace SECRET_KEY before launch. Files: `app.py`, `requirements.txt`, `.env.example`, `.gitignore` ```sh python -m venv .venv python -m pip install Flask Flask-WTF python-dotenv waitress tzdata python -m pip freeze > requirements.txt python -m flask --app app run --host 127.0.0.1 ``` 2. Implement storage and seed the named fixture For database-backed state create schema.sql and db.py using this model: sources(id,title,author,source_url); highlights(id,source_id,text,location,import_hash); reviews(id,highlight_id,at,rating); schedules(highlight_id,due_date,interval_days); notes(id,highlight_id,text). Add the auxiliary relationships explicitly used in later phases; use stable ids, foreign keys, parameterized values and transactions. For canonical files use atomic replacement and hashes instead. Implement python manage.py init and python manage.py seed to create only synthetic data: A CSV with two book highlights and a repeated row, one due today and one tomorrow. Re-running init must not erase data. Files: `schema.sql`, `db.py`, `manage.py`, `fixtures/README.md` ```sh python manage.py init python manage.py seed ``` 3. Protect the local request boundary Install Flask-WTF CSRF protection for forms and same-origin fetches, validate Host and Origin against SITE_URL, bound inputs and escape output. Deliberately public intake endpoints get bounded validation and rate limits; signed provider webhooks use signature checks instead of browser CSRF tokens. All other admin routes stay local until product authentication exists. When a later phase tests viewer/member permissions, implement the users, hashed passwords, expiring server sessions and role checks in this foundation first; product mode must never use a fabricated identity from request input. Add error, empty, keyboard-focus and retry states now. Files: `app.py`, `templates/base.html`, `test/test_foundation.py` ### Done when - [ ] The documented start command serves /healthz and the initial screen at http://127.0.0.1:5000. - [ ] Restarting preserves the seeded records or canonical files; running init again deletes nothing. - [ ] A cross-origin state-changing request to an admin route is refused. ### Watch out - The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation. ## M2 · Import without duplicates Import without duplicates for Readwise: Preview CSV mapping for title, author, highlight and location; retain source provenance per highlight. ### Steps 1. Preview CSV mapping for title, author, highlight and location; retain source provenance per highlight. Preview CSV mapping for title, author, highlight and location; retain source provenance per highlight. Files: `features/import_without_duplicates.py`, `templates/import_without_duplicates.html` 2. Generate an import identity from source, location and normalized text and show repeated rows before commit. Generate an import identity from source, location and normalized text and show repeated rows before commit. Files: `features/import_without_duplicates.py` 3. Exercise the acceptance fixture Use A CSV with two book highlights and a repeated row, one due today and one tomorrow. Check: Importing the fixture twice leaves two highlights. Then check: A changed annotation is not discarded as a duplicate highlight. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Files: `test/test_import_without_duplicates.py` ```sh python -m unittest discover -s test ``` ### Done when - [ ] Importing the fixture twice leaves two highlights. - [ ] A changed annotation is not discarded as a duplicate highlight. ### Watch out - Source title alone cannot uniquely identify a book edition or web source. ## M3 · Deterministic review Deterministic review for Readwise: Build a due-today queue with again/good responses; define fixed interval rules in code and store every review event. ### Steps 1. Build a due-today queue with again/good responses; define fixed interval rules in code and store every review event. Build a due-today queue with again/good responses; define fixed interval rules in code and store every review event. Files: `features/deterministic_review.py`, `templates/deterministic_review.html` 2. Use the user-selected local date for scheduling and show the next due date before saving a response. Use the user-selected local date for scheduling and show the next due date before saving a response. Files: `features/deterministic_review.py` 3. Exercise the acceptance fixture Use A CSV with two book highlights and a repeated row, one due today and one tomorrow. Check: Again schedules tomorrow and Good doubles the previous interval according to the documented rule. Then check: Refreshing after answering does not submit a second review. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Files: `test/test_deterministic_review.py` ```sh python -m unittest discover -s test ``` ### Done when - [ ] Again schedules tomorrow and Good doubles the previous interval according to the documented rule. - [ ] Refreshing after answering does not submit a second review. ### Watch out - A simple review scheduler is not a claim to reproduce Readwise internal algorithms. ## M4 · Annotations and notes export Annotations and notes export for Readwise: Add personal notes and source filtering; preserve quoted text separately from commentary. ### Steps 1. Add personal notes and source filtering; preserve quoted text separately from commentary. Add personal notes and source filtering; preserve quoted text separately from commentary. Files: `features/annotations_and_notes_export.py`, `templates/annotations_and_notes_export.html` 2. Export Markdown grouped by source with locations and a JSON bundle containing schedules and history. Export Markdown grouped by source with locations and a JSON bundle containing schedules and history. Files: `features/annotations_and_notes_export.py` 3. Exercise the acceptance fixture Use A CSV with two book highlights and a repeated row, one due today and one tomorrow. Check: The Markdown export distinguishes the quote from the user note. Then check: Importing a backup restores the same due queue and review count. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Files: `test/test_annotations_and_notes_export.py` ```sh python -m unittest discover -s test ``` ### Done when - [ ] The Markdown export distinguishes the quote from the user note. - [ ] Importing a backup restores the same due queue and review count. ### Watch out - Do not promise Kindle or publisher integrations; use user-exported files first. ## M5 · Portable delivery and clean-start proof Finish the Readwise replacement with a documented first-run path and a recoverable export. ### Steps 1. Write the user-facing runbook Document prerequisites, every configuration variable, data locations and the three domain workflows: Import without duplicates; Deterministic review; Annotations and notes export. Include the exclusions, actual costs and source check date 2026-09-05. Commands shown earlier that reference project files are files the builder must implement before running them. Files: `README.md`, `.env.example` 2. Create and rehearse a recoverable backup Use sqlite3.Connection.backup for the database in DATA_DIR and pause writers while taking the matching attachment snapshot. Keep schema version, hashes and a manifest for readwise. Restore into a separate empty directory or isolated deployment, with all outbound actions and schedules disabled. Recreate this proof: A CSV with two book highlights and a repeated row, one due today and one tomorrow. Compare ids/counts and open the result before recording the restore date. Never test a restore over the only live copy. Files: `OPERATIONS.md`, `scripts/backup.py` 3. Reproduce the first-run experience Use a new folder and only README instructions to reach the fixture outcome. Install from requirements.txt, initialize storage, run the tests and exercise the UI at 375px and 1280px; use keyboard-only controls and inspect browser errors. Record exactly what passed; do not mark unrun checks complete. Files: `README.md`, `verification.md` ```sh python -m pip install -r requirements.txt python -m unittest discover -s test ``` ### Done when - [ ] A new folder reaches the documented fixture outcome using only README instructions. - [ ] A backup restored in isolation preserves the proof data and can be opened. ### Watch out - Export without an import or restore rehearsal is not verified portability. ## M6 · Operate and share with access controls (production only) Product-builder only: make a highlight importer with a review queue and source-linked exports operable for its stated audience before allowing remote access. ### Steps 1. Establish owner access before exposure Add owner/member/viewer authorization as appropriate, password hashes through Werkzeug, expiring server-side sessions, CSRF and login rate limits. Add users, sessions and audit schema migrations plus an owner-init command prompting securely for its password. Enforce ownership on every private read/write/download and fail closed when product setup is incomplete. Existing learner or admin identities must use this same boundary. Files: `ARCHITECTURE.md`, `OPERATIONS.md` 2. Deploy a monitored service Serve app:app with Waitress on loopback behind Caddy HTTPS. Configure trusted proxy headers narrowly, Secure/HttpOnly/SameSite cookies, upload limits, request ids and structured logs without private content. Run background jobs as a separate supervised process when the domain workflow requires them. Files: `Caddyfile`, `OPERATIONS.md` ```sh waitress-serve --listen=127.0.0.1:5000 app:app ``` 3. Rehearse loss and recovery Add a scheduled encrypted off-host backup using this procedure: Use sqlite3.Connection.backup for the database in DATA_DIR and pause writers while taking the matching attachment snapshot. Keep schema version, hashes and a manifest for readwise. Monitor health, disk space, failed jobs and backup age. Stop the service to test an alert; rehearse recovery with outbound effects disabled and record recovery time. Rotate any exposed credentials and require reconciliation before resuming queues. Files: `OPERATIONS.md`, `release-checklist.md` ### Done when - [ ] An unauthenticated visitor cannot read private records, download private files or mutate the admin surface. - [ ] A viewer cannot mutate data by making a direct request, and guessed ids cannot cross ownership boundaries. - [ ] Stopping the service triggers the configured alert and the latest off-host backup restores the fixture in isolation. ### Watch out - Product mode is additional engineering, not a switch that makes a local prototype production-ready.
OPERATIONS.md
# Operations · Readwise ## Backup Use sqlite3.Connection.backup for the database in DATA_DIR and pause writers while taking the matching attachment snapshot. Keep schema version, hashes and a manifest for readwise. ## Restore Restore into a separate empty directory or isolated deployment, with all outbound actions and schedules disabled. Recreate this proof: A CSV with two book highlights and a repeated row, one due today and one tomorrow. Compare ids/counts and open the result before recording the restore date. Never test a restore over the only live copy. Do a restore drill before the first real user, and write the date here when it passes. ## Monitoring Check HTTP availability, free disk, backup age and domain failures for Import without duplicates, Deterministic review, Annotations and notes export. Alert without logging private payloads. ## Incident checklist Pause outbound jobs and public intake as appropriate, preserve redacted diagnostics, restore an isolated verified backup, rotate affected credentials and reconcile uncertain effects before reopening. 1. Contain the issue without destroying evidence or user data. 2. Record the timeline and affected scope. 3. Rotate exposed secrets and revoke compromised sessions or credentials. 4. Restore from a verified backup when needed. 5. Document the root cause, the remediation and the regression test. ## Release gate - [ ] Importing the fixture twice leaves two highlights. - [ ] Again schedules tomorrow and Good doubles the previous interval according to the documented rule. - [ ] The Markdown export distinguishes the quote from the user note. - [ ] A private-data authorization check passes using a second identity. - [ ] An off-host restore drill has a date, observed result and recovery time in OPERATIONS.md. - [ ] README names the excluded vendor capabilities and actual provider/hosting costs. ## Launch constraint Do not market omitted Readwise capabilities as implemented. The non-goals in `PRODUCT.md` remain user-visible limitations until they are deliberately delivered.
.env.example
# Copy to .env and fill in. Never commit .env; this file documents it. # Required. A new private folder this application creates on first run; never serve it as static files. DATA_DIR=./data/readwise # Required · secret. Generate with python -c "import secrets; print(secrets.token_hex(32))" and save only in .env. SECRET_KEY=replace-with-a-random-secret # Required. Use indie for loopback-only personal work. Product mode must refuse to start until owner login and the deployment gates are configured. APP_MODE=indie # Required. The origin used for local forms and links; replace with the chosen HTTPS origin in product mode. SITE_URL=http://127.0.0.1:5000
$ choose a build depth, inspect the files, then open the complete pack in your agent
People still pay for Readwise because people pay when capture works everywhere, reading state syncs instantly, and the archive remains clean without constant parser repairs. The recurring cost buys feed quirks, parsing, paywalls, canonical URLs, deduplication, images, search, sync, browser extensions, and publisher changes, not just the visible interface.
xbroad source integrations, sync, daily review polish, and knowledge-tool exports
xpublisher bypasses
xcross-device mobile capture
xhigh-quality recommendation graph
xlicensed full-text feeds
share on X ↗"I just replaced Readwise ($9.99/mo) with one prompt"
Readwise pricing
| plan | monthly | annual (per mo) | what you get |
|---|---|---|---|
| readwise lite | — | $5.59/user | Daily Review, browsing/search and highlight sync; excludes tags, notes, exports and Reader. |
| readwise full | $12.99/user | $9.99/user | Readwise Lite plus tags, notes, exports and the full Reader app. |
free tierno free tier; 30-day trial
billingmonthly + annual; the public page exposes only the annual Lite rate
hidden costsstudents and academics can receive 50% off; continuous subscribers may retain a legacy locked price
verified 2026-08-13 · source ↗
Vibecode Readwise
Kinda. The core of Readwise is buildable in a weekend with the prompt on this page, but there are real gaps: broad source integrations, sync, daily review polish, and knowledge-tool exports, publisher bypasses. Read the honest list above before committing.
How much does Readwise cost?
Readwise costs about $9.99/month (Readwise Full, checked 2026-07-31), which is $119.88 per year.
What do I lose by replacing Readwise?
Honestly: broad source integrations, sync, daily review polish, and knowledge-tool exports; publisher bypasses; cross-device mobile capture; high-quality recommendation graph; licensed full-text feeds. If any of those are load-bearing for you, keep paying.
Is there an open-source alternative to Readwise?
Yes: FreshRSS (Mature open-source RSS reader with feeds, filters, and self-hosting support.). Using prior art is also vibecoding; the prompt is for when you want it exactly your way.