ocrmypdf-web is a web-based front end for OCRmyPDF, a free and open-source tool that converts scanned documents to searchable PDFs.
This project is inspired by sseemayer/OCRmyPDF-web with the following key differences:
- Flask-based web server (instead of Hug)
- Grossly blank web UI; the advantage being no JS required
- Uses
OCRmyPDF's Python API directly (instead of invoking the CLIocrmypdfusing a subprocess)
Otherwise, it's conceptually the same and I encourage you to pick what suits you.
This project is also assisted through ChatGPT (based on the GPT-3.5 model at the time). The full interaction log can be found in ChatGPT.md. Not everything was helpful but this makes experimenting and iterating on small side projects much more enjoyable than they already were.
- Docker (with
docker-compose)
To run ocrmypdf-web locally, follow these steps:
- Clone this repository to your local machine.
- Navigate to the root directory of the cloned repository.
- Build the Docker image:
docker-compose build. - Start the Docker container:
docker-compose up. - Open your web browser and navigate to
http://localhost:8080.
ocrmypdf-web provides a simple web interface for uploading PDF files and running OCRmyPDF on them. To use ocrmypdf-web:
- Navigate to
http://localhost:8080in a web browser. - Click the "Browse..." button and select a PDF file to upload.
- Optionally select OCR options.
- Click the "OCR PDF" button.
- Once the conversion is complete, the resulting PDF will be downloaded (or opened) by your browser.
If something goes wrong, you'll generally be led to the /ocrmypdf path in your browser with some error message to help you understand what went wrong.
Go back to the index page (where the PDF upload and OCR buttons are). To reset the form on the page, click the "Reset" button.
Issues and pull requests are welcome!
This project is licensed under the MIT License - see the LICENSE file for details.