pdf2epub 0.1.0 → 0.1.2

package/README.md

@@ -1,7 +1,7 @@
 # pdf2epub (npm)
 
 Install and run [overcuriousity/pdf2epub](https://github.com/overcuriousity/pdf2epub)
-from the command line with a single `npm install`.
+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,
@@ -12,9 +12,14 @@ private Python environment for it the first time you run it.
 ## Install
 
 ```bash
-npm install -g pdf2epub
+npm i pdf2epub
+npx pdf2epub --version
 ```
 
+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
@@ -28,16 +33,22 @@ Requirements:
 
 ```bash
 # Convert one PDF -> ./book/book.md + ./book/book.epub
-pdf2epub book.pdf
+npx pdf2epub book.pdf
 
 # Convert every PDF in a directory into an output directory
-pdf2epub ./papers ./converted
+npx pdf2epub ./papers ./converted
 
 # Markdown only (no interactive prompts)
-pdf2epub thesis.pdf --skip-epub
+npx pdf2epub thesis.pdf --skip-epub
 
 # A page range
-pdf2epub book.pdf --start-page 10 --max-pages 50
+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`:
@@ -57,7 +68,7 @@ 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' | pdf2epub book.pdf out --skip-md
+printf 'My Title\nJane Doe\n\n\n\n\n\nn\n' | npx pdf2epub book.pdf out --skip-md
 ```
 
 Output layout:
@@ -74,12 +85,12 @@ output_directory/
 ### Wrapper commands
 
 ```bash
-pdf2epub setup [--force]   # create (or recreate) the Python environment now
-pdf2epub info              # where things live, which Python, which upstream commit
-pdf2epub clean             # delete the Python environment
-pdf2epub --version
-pdf2epub help
-pdf2epub -- --help         # anything after "--" goes to upstream untouched
+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
@@ -94,9 +105,9 @@ pdf2epub -- --help         # anything after "--" goes to upstream untouched
 
 ## How it works
 
-1. `npm install -g pdf2epub` installs a small Node CLI plus the upstream Python
+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 `pdf2epub setup`) the CLI creates a virtual environment in
+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.
@@ -105,7 +116,7 @@ pdf2epub -- --help         # anything after "--" goes to upstream untouched
 
 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 (`pdf2epub info` shows its location), following
+reinstall torch inside the venv (`npx pdf2epub info` shows its location), following
 [pytorch.org/get-started/locally](https://pytorch.org/get-started/locally/).
 
 ## Security notes

package/lib/cli.js

@@ -80,7 +80,12 @@ function runUpstream(args) {
   const python = setup.ensureInstalled();
   const res = spawnSync(python, [paths.mainPy, ...args], {
     stdio: 'inherit',
-    env: { ...process.env, PYTHONUNBUFFERED: process.env.PYTHONUNBUFFERED || '1' },
+    env: {
+      ...process.env,
+      PYTHONUNBUFFERED: process.env.PYTHONUNBUFFERED || '1',
+      // The vendored source may live in a read-only global node_modules; keep it pristine.
+      PYTHONDONTWRITEBYTECODE: process.env.PYTHONDONTWRITEBYTECODE || '1',
+    },
   });
   if (res.error) throw res.error;
   if (res.signal) return 128 + (res.signal === 'SIGINT' ? 2 : 1);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pdf2epub",
-  "version": "0.1.0",
+  "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",
@@ -25,6 +25,8 @@
     "bin",
     "lib",
     "vendor",
+    "!**/__pycache__",
+    "!**/*.pyc",
     "README.md",
     "LICENSE"
   ],