Code Monkey home page Code Monkey logo

prpdf's Introduction

PR PDF - scan documents explorer and automation

Preview and Rename PDF Explorer\ A webbased document explorer and automation. For easy view, rename and move scanned PDF files.

Background and Motivation:

I was searching for a easy to use solution to get my letters and paper digital.
Since I was searching for a solution for my unraid NAS, solutions like paperwork dont work as docker/in web or on many computer.
Programs like Paperless and Papermerge are great but much to heavy with database etc.
I like to keep my files in a normal folder structure to share and access them from every pc.
Thats how PR PDF started. As an lightwight easy to use web based application to make it easy to preview, rename and move scanned documents.

BETA Note:

This program is very new and theres a lot to test. Please report issues to the issues tab on github.

Functions:

  • PDF OCR Autoscan will move known documents based on keywords
  • Preview and Rename documents from a web browser
  • PDF Merge let you merge documents (1+1 and front and back pages)
  • Split documents
  • Manual rename and move

How it works:

  1. Documents get scanned to a scan-folder
  2. these documents will be autoscanned and moved to the specific locations
  3. Any files that are not recognized by autoscan will be moved to the subfolder "unknown" of the scan-folder
  4. The Webbased PR PDF Explorer lists all documents of the "unknown" folder.

How it looks like:

Explorer OCR

Install and run

Run as docker

docker pull knex666/prpdf

docker run -d --name='PRPDF' -p 80:80 -v '/mnt/user/Share':'/Archiv/':'rw' -v '/mnt/user/SCAN':'/source/static/pdf/':'rw' -v '/mnt/user/appdata/prpdf/':'/source/config':'rw' 'knex666/prpdf' python3 /source/prpdf.py

  • Note 1: remember to setup the network to map the port of your configuration -p 80:80 you can choose any port you want see config
  • Note 2: besited a folder structure for documents in a folder you mount to /Archiv/ you can volume mount any directory you want to /Archiv/ to build you own virtual folder structure -v '/mnt/user/Files/Accounting':'/Archiv/Accounting':'rw' etc.

Run with python on linux

Note: Please ensure to run it from /source/ create a folder /Archiv for your files and a folder /source/static/pdf/ as location for you scanned pdfs otherwise feel free to edit the sourcecode on vars.py etc.

  • python3 -m pip install -r requirements.txt
  • sudo apt-get install tesseract-ocr poppler-utils
  • python3 prpdf.py

Configuration

A default config will be creating within the first start of PR PDF. For Docker please mount the config folder to make it persistent. An example: https://github.com/maschhoff/prpdf/blob/main/config/config.json

"port":80, - choose any port you want
"debug":"off", set so on or off to see ocr results while autoscan
"lang":"deu", set the ocr language see https://tesseract-ocr.github.io/tessdoc/Data-Files-in-different-versions.html
"updatetime":1800, uptime in seconds

Donate

If you like what you see please buy me a Pizza -> https://www.buymeacoffee.com/maschhoff

prpdf's People

Contributors

maschhoff avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.