pdf2epub 0.1.2 → 0.1.4

package/README.md

@@ -1,141 +1,47 @@
-# pdf2epub (npm)
+# pdf2epub
 
-Install and run [overcuriousity/pdf2epub](https://github.com/overcuriousity/pdf2epub)
-from the command line with a single `npm i pdf2epub`.
-
-pdf2epub converts PDF files to cleanly structured Markdown and EPUB using
-[marker-pdf](https://github.com/datalab-to/marker) for AI layout detection,
-OCR, table and image extraction. The upstream project is written in Python;
-this package bundles a pinned copy of its source and takes care of creating a
-private Python environment for it the first time you run it.
+Convert a PDF into a reflowable EPUB 3 ebook that works on Kindle (via Send-to-Kindle / Calibre), Kobo, Apple Books and other readers.
 
 ## Install
 
 ```bash
-npm i pdf2epub
-npx pdf2epub --version
+npm install
 ```
 
-This adds `pdf2epub` to your project; run it with `npx pdf2epub ...` or from an
-npm script. (A global install with `npm i -g pdf2epub` gives you a plain
-`pdf2epub` command instead.)
-
-Requirements:
-
-- Node.js 18 or newer
-- Either [uv](https://docs.astral.sh/uv/) (recommended; it fetches Python 3.13 by itself)
-  or Python 3.10–3.13 on your `PATH` (`python3.13`, `python3.12`, ...).
-- Disk space and a network connection for the first run: PyTorch and marker-pdf
-  (several hundred MB) are installed once, and marker-pdf downloads its models
-  from Hugging Face the first time it converts a document.
-
 ## Usage
 
 ```bash
-# Convert one PDF -> ./book/book.md + ./book/book.epub
-npx pdf2epub book.pdf
-
-# Convert every PDF in a directory into an output directory
-npx pdf2epub ./papers ./converted
-
-# Markdown only (no interactive prompts)
-npx pdf2epub thesis.pdf --skip-epub
-
-# A page range
-npx pdf2epub book.pdf --start-page 10 --max-pages 50
-```
-
-Or as an npm script in `package.json`:
-
-```json
-{ "scripts": { "convert": "pdf2epub ./input ./output --skip-epub" } }
-```
-
-All arguments are passed straight through to upstream's `main.py`:
-
-```
-input_path               PDF file or directory (default: ./input/*.pdf)
-output_path              Output directory (default: directory named after the PDF)
---max-pages INT          Maximum number of pages to process
---start-page INT         Page number to start from (requires --max-pages)
---skip-epub              Only create Markdown; no interactive EPUB prompts
---skip-md                Reuse existing Markdown, only build the EPUB
-```
-
-EPUB generation asks for metadata (title, author, language, ...) interactively,
-so it needs a terminal. In scripts and CI use `--skip-epub`, or feed the answers
-on stdin: seven metadata prompts (Enter keeps the default) followed by `n` to
-skip the Markdown review step:
-
-```bash
-printf 'My Title\nJane Doe\n\n\n\n\n\nn\n' | npx pdf2epub book.pdf out --skip-md
-```
-
-Output layout:
-
-```
-output_directory/
-└── document_name/
-    ├── document_name.md
-    ├── document_name.epub
-    ├── document_name_metadata.json
-    └── images/
-```
-
-### Wrapper commands
-
-```bash
-npx pdf2epub setup [--force]   # create (or recreate) the Python environment now
-npx pdf2epub info              # where things live, which Python, which upstream commit
-npx pdf2epub clean             # delete the Python environment
-npx pdf2epub --version
-npx pdf2epub help
-npx pdf2epub -- --help         # anything after "--" goes to upstream untouched
-```
-
-### Environment variables
-
-| Variable             | Purpose                                                              | Default        |
-| -------------------- | -------------------------------------------------------------------- | -------------- |
-| `PDF2EPUB_HOME`      | Directory holding the Python venv and install state                  | `~/.pdf2epub`  |
-| `PDF2EPUB_PYTHON`    | Interpreter to use (a path, or a version like `3.12` when using uv)  | auto-detected  |
-| `PDF2EPUB_INSTALLER` | `auto` (uv if present, else `venv` + `pip`) or `pip`                 | `auto`         |
-| `HF_HOME`            | Hugging Face cache where marker-pdf stores its models                 | HF default     |
-| `TORCH_DEVICE`       | Force a device for marker-pdf (`cpu`, `cuda`, `mps`)                  | auto           |
+node pdf2epub.js book.pdf                      # -> book.epub
+node pdf2epub.js book.pdf -o out.epub -t "Title" -a "Author" -l vi
+node pdf2epub.js book.pdf -c cover.jpg         # embed a cover image
+node pdf2epub.js book.pdf --split pages --pages-per-chapter 5
+```
+
+| Option | Description |
+|---|---|
+| `-o, --output <file>` | Output path (default: input name with `.epub`) |
+| `-t, --title <text>` | Override title (default: PDF metadata, then filename) |
+| `-a, --author <text>` | Override author |
+| `-l, --lang <code>` | Language code, e.g. `en`, `vi` (default `en`) |
+| `-c, --cover <image>` | JPG/PNG cover image to embed |
+| `--split <mode>` | `auto`, `outline` (PDF bookmarks), `headings` (font size), `pages` |
+| `--pages-per-chapter <n>` | Pages per chapter in `pages` mode (default 10) |
+| `--keep-headers` | Keep repeating page headers/footers and page numbers |
+| `--font-scale <n>` | Heading detection threshold relative to body font (default 1.15) |
 
 ## How it works
 
-1. `npm i pdf2epub` installs a small Node CLI plus the upstream Python
-   source pinned to a specific commit (see `vendor/pdf2epub/UPSTREAM.json`).
-2. On first use (or `npx pdf2epub setup`) the CLI creates a virtual environment in
-   `PDF2EPUB_HOME` with uv or `python -m venv` and installs upstream's
-   `requirements.txt` (marker-pdf, transformers, PyTorch, ...).
-3. Every invocation then runs `python main.py <your args>` inside that venv.
-   Upgrading the npm package to a version with different requirements or a new
-   upstream commit triggers a reinstall automatically.
-
-GPU acceleration follows upstream: the default PyTorch wheel supports CUDA on
-Linux/Windows and MPS on Apple Silicon. For ROCm or a specific CUDA build,
-reinstall torch inside the venv (`npx pdf2epub info` shows its location), following
-[pytorch.org/get-started/locally](https://pytorch.org/get-started/locally/).
+1. Extracts positioned text from every page with `pdfjs-dist`.
+2. Rebuilds lines and paragraphs from coordinates, joins wrapped lines and undoes end-of-line hyphenation.
+3. Strips running headers, footers and page numbers that repeat across pages.
+4. Detects headings by font size; splits chapters from PDF bookmarks when present.
+5. Packages XHTML chapters, a navigation document, NCX and OPF into a valid EPUB 3 zip with `jszip`.
 
-## Security notes
+## Privacy
 
-Upstream pins `transformers==4.57.6` because `marker-pdf 1.10.2` requires
-`transformers<5`. Published advisories for transformers 4.x concern loading
-model files or remote code from untrusted sources; pdf2epub only loads the fixed
-marker-pdf models from Hugging Face. Do not point it at untrusted model
-repositories.
-
-## Development
-
-```bash
-npm test                      # fast unit tests (no Python required)
-npm run test:e2e              # also builds a real venv and runs upstream --help
-npm run sync-upstream -- v1.1.0   # re-vendor a specific upstream ref
-```
+pdf2epub makes no network requests of its own: it reads your PDF and writes an EPUB, nothing else. (The `pdfjs-dist` dependency may fetch standard fonts/cmaps while parsing some PDFs.)
 
-## License
+## Limitations
 
-MIT. The bundled pdf2epub source is © overcuriousity, MIT licensed
-(`vendor/pdf2epub/LICENSE`).
+- Scanned (image-only) PDFs have no text layer. Run OCR first, e.g. `ocrmypdf in.pdf out.pdf`.
+- Images, tables and multi-column layouts are converted to plain text; figures are not embedded.

package/package.json

@@ -1,52 +1,17 @@
 {
   "name": "pdf2epub",
-  "version": "0.1.2",
-  "description": "CLI wrapper that installs and runs overcuriousity/pdf2epub: convert PDF files to structured Markdown and EPUB with AI layout detection (marker-pdf). Bootstraps its own Python environment on first run.",
-  "keywords": [
-    "pdf",
-    "epub",
-    "markdown",
-    "pdf2epub",
-    "pdf-to-epub",
-    "marker-pdf",
-    "ocr",
-    "ebook",
-    "converter",
-    "cli"
-  ],
-  "homepage": "https://github.com/overcuriousity/pdf2epub#readme",
-  "bugs": "https://github.com/overcuriousity/pdf2epub/issues",
-  "license": "MIT",
-  "author": "dalt4sec",
+  "version": "0.1.4",
+  "description": "Convert PDF files to EPUB ebooks",
+  "type": "module",
   "bin": {
-    "pdf2epub": "bin/pdf2epub.js"
+    "pdf2epub": "./pdf2epub.js"
   },
-  "files": [
-    "bin",
-    "lib",
-    "vendor",
-    "!**/__pycache__",
-    "!**/*.pyc",
-    "README.md",
-    "LICENSE"
-  ],
   "scripts": {
-    "test": "node --test \"test/*.test.js\"",
-    "test:e2e": "PDF2EPUB_E2E=1 node --test \"test/*.test.js\"",
-    "sync-upstream": "node scripts/sync-upstream.js",
-    "prepublishOnly": "npm test"
-  },
-  "engines": {
-    "node": ">=18"
+    "start": "node pdf2epub.js"
   },
-  "publishConfig": {
-    "access": "public"
-  },
-  "pdf2epub": {
-    "upstream": {
-      "repo": "overcuriousity/pdf2epub",
-      "ref": "v1.1.0",
-      "commit": "5eae669d1c897b4735f369fb2ff4086237db3a81"
-    }
+  "license": "MIT",
+  "dependencies": {
+    "jszip": "^3.10.1",
+    "pdfjs-dist": "^4.10.38"
   }
 }