Metadata-Version: 2.4
Name: scan-pdf-cleaner-cli
Version: 1.0.0
Summary: Automatically detect and remove blank pages, and crop margins from scanned PDFs.
Home-page: https://thefreeconverter.com/converters/pdf-tools/crop-pdf
Author: TheFreeConverter
Author-email: contact@thefreeconverter.com
Project-URL: Source, https://github.com/The-Free-Converter/scan-pdf-cleaner
Project-URL: Bug Tracker, https://github.com/The-Free-Converter/scan-pdf-cleaner/issues
Project-URL: Online Crop Tool, https://thefreeconverter.com/converters/pdf-tools/crop-pdf
Project-URL: Online Split Tool, https://thefreeconverter.com/converters/pdf-tools/split-merge-edit-pdf-pages
Project-URL: Documentation, https://thefreeconverter.com
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Utilities
Classifier: Topic :: Printing
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pypdf>=4.0.0
Requires-Dist: pypdfium2>=4.28.0
Requires-Dist: numpy>=1.24.0
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license-file
Dynamic: project-url
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# Scan PDF Cleaner CLI

[![PyPI version](https://img.shields.io/badge/pypi-v1.0.0-blue.svg)](https://pypi.org/project/scan-pdf-cleaner-cli/)
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
[![Web Tool](https://img.shields.io/badge/Online%20Tool-TheFreeConverter-emerald)](https://thefreeconverter.com/converters/pdf-tools/crop-pdf)

A high-speed CLI utility and Python library to automatically detect and delete blank pages from scanned PDFs, remove whitespace borders, and clean multi-page document batches.

An online browser-based version is available at [TheFreeConverter PDF Tools](https://thefreeconverter.com/converters/pdf-tools/crop-pdf).

---

## Features

- **Blank-Page Detection**: Evaluates ink density and page bitmap intensity to accurately remove blank scan backs and separator pages.
- **Margin Auto-Cropping**: Automatically trims outer scanner borders and non-printable margins.
- **Batch Processing**: Clean entire folders of digitized contracts, scans, or receipts quickly.
- **Local Execution**: Runs entirely on your local machine without third-party network requests.

---

## Installation

```bash
pip install scan-pdf-cleaner-cli
```

Or install from source:

```bash
git clone https://github.com/The-Free-Converter/scan-pdf-cleaner.git
cd scan-pdf-cleaner
pip install -r requirements.txt
pip install -e .
```

---

## Quickstart & CLI Usage

### 1. Remove blank pages from a PDF
```bash
scan-pdf-cleaner scanned_document.pdf
# Outputs: scanned_document_cleaned.pdf
```

### 2. Remove blank pages AND crop margins
```bash
scan-pdf-cleaner document.pdf --crop -o ./clean_doc.pdf
```

### 3. Adjust blank-page sensitivity threshold
```bash
# Higher threshold (e.g. 1.0) considers pages with light scanner noise as blank
scan-pdf-cleaner document.pdf --threshold 1.0
```

---

## Python API Usage

```python
from scan_pdf_cleaner import remove_blank_pages, crop_pdf_margins

# Remove blank pages
retained, removed = remove_blank_pages("scanned_batch.pdf", "output_cleaned.pdf")
print(f"Kept {retained} pages; discarded {removed} blank pages.")

# Crop margins
crop_pdf_margins("output_cleaned.pdf", "final_cropped.pdf", margin_pt=36.0)
```

---

## Online Web Tools

Browser-based PDF processing tools:
- [Crop PDF Margins Online](https://thefreeconverter.com/converters/pdf-tools/crop-pdf)
- [Split, Merge and Edit PDF Pages](https://thefreeconverter.com/converters/pdf-tools/split-merge-edit-pdf-pages)
- [Compress Heavy PDF Files](https://thefreeconverter.com/converters/pdf-tools/compress-pdf)

---

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
