breviabook 0.1.0__tar.gz

breviabook-0.1.0/.claude/settings.local.json

@@ -0,0 +1,22 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(git init *)",
+      "Bash(git config *)",
+      "Bash(curl -fsSL https://www.apache.org/licenses/LICENSE-2.0.txt -o LICENSE)",
+      "Bash(uv run *)",
+      "Bash(brew --prefix)",
+      "Bash(DYLD_FALLBACK_LIBRARY_PATH=/opt/homebrew/lib uv run pytest -q)",
+      "Bash(DYLD_FALLBACK_LIBRARY_PATH=/opt/homebrew/lib uv run python -m tests.fixtures._build_sample_pdf)",
+      "Bash(ollama ps *)",
+      "Bash(ollama stop *)",
+      "Bash(DYLD_FALLBACK_LIBRARY_PATH=/opt/homebrew/lib uv run *)",
+      "Bash(curl -s -o /dev/null -w \"%{http_code}\" https://pypi.org/pypi/brevia/json)",
+      "Bash(DYLD_FALLBACK_LIBRARY_PATH=/opt/homebrew/lib uv lock)",
+      "Bash(DYLD_FALLBACK_LIBRARY_PATH=/opt/homebrew/lib uv build)",
+      "Bash(git grep *)",
+      "Bash(gh repo *)",
+      "Bash(gh run *)"
+    ]
+  }
+}

breviabook-0.1.0/.env.example

@@ -0,0 +1,21 @@
+# Brevia configuration — copy to .env and edit. NEVER commit your real .env.
+# See docs/ROADMAP.md §9.
+
+# --- Provider selection ---
+LLM_PROVIDER=ollama
+OLLAMA_ENDPOINT=http://localhost:11434
+
+# Default model. gemma4:e4b is fast and light (Gemma 4 edge, ~12GB RAM, 128K ctx).
+# For best long-document summarization quality on a 36GB machine, prefer: qwen3:30b
+# (Qwen3-30B-A3B MoE — ~3.3B active params so it stays fast, 256K context).
+DEFAULT_MODEL=gemma4:e4b
+
+# --- API keys (cloud providers; Phase 9). Comma-separated for key rotation. ---
+OPENAI_API_KEY=
+GEMINI_API_KEY=
+OPENROUTER_API_KEY=
+
+# --- Condensation defaults ---
+DEFAULT_TARGET_RATIO=0.30
+DEFAULT_CHUNK_TOKENS=2000
+IMAGE_STRATEGY=keep_referenced   # keep_referenced | vision_ranked

breviabook-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,42 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  quality:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install weasyprint system libraries
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y libpango-1.0-0 libpangocairo-1.0-0 \
+            libgdk-pixbuf-2.0-0 libffi-dev libcairo2
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Set up Python
+        run: uv python install 3.11
+
+      - name: Install dependencies
+        run: uv sync --all-extras --dev
+
+      - name: Ruff (lint)
+        run: uv run ruff check .
+
+      - name: Ruff (format check)
+        run: uv run ruff format --check .
+
+      - name: Mypy (strict)
+        run: uv run mypy --strict breviabook
+
+      - name: Pytest
+        run: uv run pytest -q
+
+      - name: License audit (fail on any GPL/AGPL dependency)
+        run: uv run pip-licenses --fail-on "GPL"

breviabook-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,51 @@
+name: release
+
+# Publish to PyPI on a version tag (e.g. v0.1.0) via PyPI Trusted Publishing (OIDC) — no
+# API tokens stored. One-time setup on PyPI: add a "trusted publisher" for project
+# "breviabook" pointing at owner=willywg, repo=breviabook, workflow=release.yml,
+# environment=pypi. See https://docs.pypi.org/trusted-publishers/
+
+on:
+  push:
+    tags: ["v*"]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Verify tag matches package version
+        run: |
+          TAG="${GITHUB_REF_NAME#v}"
+          PKG="$(uv run python -c 'import breviabook; print(breviabook.__version__)')"
+          echo "tag=$TAG package=$PKG"
+          test "$TAG" = "$PKG" || { echo "::error::tag v$TAG != package version $PKG"; exit 1; }
+
+      - name: Build sdist and wheel
+        run: uv build
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/breviabook
+    permissions:
+      id-token: write # required for Trusted Publishing
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

breviabook-0.1.0/.gitignore

@@ -0,0 +1,52 @@
+# --- Secrets & local config (see ROADMAP §12: never commit API keys) ---
+.env
+.env.*
+!.env.example
+*.key
+secrets/
+
+# --- Job state / checkpoints / databases (never commit, ROADMAP §12) ---
+*.sqlite
+*.sqlite3
+*.db
+checkpoints/
+.breviabook/
+output/
+out/
+
+# --- Reference repos must stay OUTSIDE the tree (ROADMAP §14) ---
+# (kept here as a guard in case someone clones them in by accident)
+TranslateBooksWithLLMs/
+ollama-ebook-summary/
+OllamaBook-Summarize/
+
+# --- Python ---
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+.eggs/
+build/
+dist/
+.venv/
+venv/
+env/
+.python-version
+
+# --- Tooling caches ---
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+
+# --- Editors / OS ---
+.vscode/
+.idea/
+*.swp
+.DS_Store
+
+# --- Test artifacts (keep fixtures, ignore generated) ---
+tests/output/
+*.generated.*

breviabook-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,24 @@
+# Pre-commit hooks (ROADMAP §4). Install with: uv run pre-commit install
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.5.7
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+
+  - repo: local
+    hooks:
+      - id: mypy
+        name: mypy (strict)
+        entry: uv run mypy --strict breviabook
+        language: system
+        types: [python]
+        pass_filenames: false
+
+      - id: pytest
+        name: pytest
+        entry: uv run pytest -q
+        language: system
+        types: [python]
+        pass_filenames: false

breviabook-0.1.0/CHANGELOG.md

@@ -0,0 +1,29 @@
+# Changelog
+
+All notable changes to BreviaBook are documented here. The format follows
+[Keep a Changelog](https://keepachangelog.com/), and the project adheres to
+[Semantic Versioning](https://semver.org/).
+
+## [0.1.0] — 2026-06-25
+
+First public release. Condenses large technical ebooks (EPUB/PDF) to ~25–50% while
+preserving code, tables, and meaningful figures, with optional same-pass translation.
+
+### Added
+- Format-agnostic IR (`Document → Chapter → Block`) with EPUB and PDF parsers (no
+  GPL/AGPL deps: own EPUB builder, `pdfplumber`/`pypdf`, never `ebooklib`/PyMuPDF).
+- Hierarchical condensation (per-chunk condense + per-chapter synthesis with length
+  control); **code blocks are never summarized or split**.
+- Integrated translation of the condensed book, with optional glossary; runs in resilient
+  batches that retry and fall back to source text instead of crashing.
+- Image preservation (Strategy A) plus optional vision ranking (`--rank-images`).
+- Outputs: EPUB (own builder), PDF (weasyprint, optional `[pdf]` extra), Markdown.
+- Multi-provider LLM via litellm: Ollama, OpenAI, Gemini, OpenRouter, and any
+  OpenAI-compatible endpoint; key rotation and failover.
+- Live TUI: banner, per-phase progress bars, and a real-time token/cost usage panel.
+- `--reasoning-effort` control; thinking is **disabled by default** for Gemini (rewriting
+  tasks gain nothing from it and it costs ~3.6× more).
+- `--dry-run` token/page/compression/cost estimate; per-run usage report; compression and
+  approximate page counts; `--resume` from a JSONL checkpoint.
+
+[0.1.0]: https://github.com/willywg/breviabook/releases/tag/v0.1.0

breviabook-0.1.0/CLAUDE.md

@@ -0,0 +1,72 @@
+# CLAUDE.md — BreviaBook
+
+Guidance for AI agents working in this repository. The complete specification and
+phased build plan live in **[docs/ROADMAP.md](docs/ROADMAP.md)** — that document is
+the source of truth; this file is the quick operating manual.
+
+## What BreviaBook is
+
+A CLI that takes a large technical ebook (EPUB/PDF, 200–400 pages) and produces a
+**condensed version** (~25–50% of the original) that preserves **code, formulas, and
+essential images/diagrams**, optionally **translated** in the same pass. Outputs
+EPUB, PDF, and Markdown. Multi-provider LLM (Ollama, OpenAI, Gemini, OpenRouter, and
+any OpenAI-compatible endpoint).
+
+## Core architectural principle (read first)
+
+Everything flows through a **format-agnostic Intermediate Representation (IR)** —
+`Document → Chapter → Block` (pydantic). Parsers produce IR, the condenser/translator
+transform IR text blocks, renderers consume IR. **`code` and `image` blocks are never
+summarized or split.** Adding a format = one parser or one renderer, nothing else.
+See ROADMAP §3 and §6 for the model and folder layout.
+
+Pipeline: `parse → chunk → condense → synthesize → (translate) → image-select → render`,
+with checkpoint/resume between chunking and translation. See ROADMAP §5.
+
+## License rules — NON-NEGOTIABLE (ROADMAP §14)
+
+- Project license: **Apache-2.0**.
+- **Clean-room only.** The reference repos (TranslateBooksWithLLMs, ollama-ebook-summary,
+  OllamaBook-Summarize) are **study material, never copy material**. Never copy/paste or
+  line-by-line translate their code. Keep them OUTSIDE this tree (`~/projects/open-source/`),
+  never vendor or submodule them.
+- **No AGPL/GPL runtime dependencies — ever.** Forbidden: `ebooklib`, `PyMuPDF`/`fitz`.
+  Use the permissive substitutes below. CI enforces this with `pip-licenses --fail-on "GPL"`.
+- **Never commit** API keys or job databases (`.env`, `*.sqlite` are gitignored).
+
+## Tech stack (permissive only)
+
+- Python **3.11+**, package manager **`uv`**.
+- CLI: `typer` + `rich`. Config: `pydantic` v2 + `python-dotenv`.
+- EPUB: our own builder with `zipfile` (stdlib) + `lxml`/`beautifulsoup4` — **not ebooklib**.
+- PDF read: `pdfplumber` + `pypdf` — **not PyMuPDF**. PDF write: `weasyprint`.
+- Tokens: `tiktoken` (char-based fallback). LLM: `litellm` (preferred) and/or `httpx`.
+- NER glossary (late phase): `spacy`.
+
+## Quality gates (must pass from Phase 0)
+
+```bash
+uv run ruff check .            # lint (rules: E,F,I,UP,B,SIM)
+uv run ruff format --check .   # format
+uv run mypy --strict breviabook    # types — strict mode, type the whole pipeline
+uv run pytest                  # tests (pytest + pytest-asyncio)
+uv run pip-licenses --fail-on "GPL"   # license audit — blocks any GPL/AGPL dep
+```
+
+`ruff` and `mypy` must pass clean from the first commit. Use a deterministic **mock
+provider** for pipeline tests; don't call a real LLM in tests.
+
+## Workflow
+
+This project is driven by the **PRP (Product Requirement Prompt) workflow**. Each phase
+in ROADMAP §10 (Phase 0 → Phase 12) becomes one PRP under `PRPs/`. Build phases **in
+order**; each must be functional and tested before the next. **MVP = Phases 0–7.**
+
+## Things NOT to do (ROADMAP §12)
+
+- Don't copy TBL's 1:1 placeholder reinjection — we build a fresh EPUB from scratch.
+- Don't use ~450-token chunks; summarization needs ~2000-token chunks.
+- Never split a `code` block or a table across chunks.
+- Validate entry paths when unpacking EPUBs (zip-slip). Don't forward provider keys to an
+  arbitrary `--api-endpoint` (SSRF). See `breviabook/utils/security.py`.
+- "Output longer than input" is a red flag — detect and warn.

breviabook-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

breviabook-0.1.0/NOTICE

@@ -0,0 +1,24 @@
+BreviaBook
+Copyright 2026 William Wong Garay
+
+This product includes software developed by William Wong Garay and contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this
+file except in compliance with the License. You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+-------------------------------------------------------------------------------
+Attribution (no code reused)
+-------------------------------------------------------------------------------
+
+BreviaBook's architecture was studied and inspired by the following open-source projects.
+No code from these projects is reused in BreviaBook; they served as study material only
+(clean-room reimplementation — see docs/ROADMAP.md §14):
+
+  * TranslateBooksWithLLMs (hydropix)        — provider-layer and checkpoint patterns
+  * ollama-ebook-summary (cognitivetech)     — chapter-aware chunking lessons
+  * OllamaBook-Summarize (sanjaymarison)     — table-of-contents inference idea
+
+BreviaBook depends only on permissively licensed (MIT/BSD/Apache) libraries; it uses no
+GPL/AGPL dependencies at runtime.