Skip to main content

Tool to scan and process documents to palerless

Project description

Scan and prepare your document for paperless

Usage

  1. Use the scan command, with auto-completion on your correspondents and your tags to import your document, to scan your documents.

  2. The document is transferred to your NAS (I use Syncthing).

  3. The documents will be processed on the NAS.

  4. Use scan-process-status to know the status of your documents.

  5. Validate your documents.

  6. If your happy with that remove the REMOVE_TO_CONTINUE file. (To restart the process remove one of the generated images, to cancel the job just remove the folder).

  7. The process will continue his job and import the document in paperless.

Nice feature

Double sized scanning

  1. Pour your sheets on the Automatic Document Feeder.

  2. Run scan with the option --double-sided.

  3. Press enter to start scanning the first side of all sheets.

  4. Put again all your sheets on the Automatic Document Feeder without turning them.

The scan utils will rotate and reorder all the sheets to get a good document.

Credit card scanning

The options --append-credit-card will append all the sheets vertically to have the booth face of the credit card on the same page.

Assisted split

  1. Do your scan as usual with the extra option --assisted-split.

  2. After the process do his first pass you will have images with lines and numbers. The lines represent the detected potential split of the image, the length indicate the strength of the detection. In your config you will have somthing like:

assisted_split:
- destinations:
  - 4  # Page number of the left part of the image
  - 1  # Same for the right page of the image
  image: image-1.png  # name of the image
  limits:
  - margin: 0  # Margin around the split
    name: 0  # Number visible on the generated image
    value: 375  # The position of the split (can be manually edited)
    vertical: true  # Will split the image vertically
  - ...
  source: /source/975468/7-assisted-split/image-1.png
- ...

Edit your config file, you should have one more destination then the limits. If you put destinatination like that: 2.1, it mean that it will be the first part of the page 2 and the 2.2 will be the secound part.

  1. Delete the file REMOVE_TO_CONTINUE.

  2. After the process do his first pass you will have the final generated images.

  3. If it's OK delete the file REMOVE_TO_CONTINUE.

Install

Install in a venv in the home directory:

$ cd
$ python3 -m venv venv
$ ~/venv/bin/pip install scan-to-paperless
$ sudo activate-global-python-argcomplete
$ echo PATH=$PATH:~/venv/bin >> ~/.bashrc

NAS

The Docker support is required, Personally I use a Synology DiskStation DS918+, and you can get the *.syno.json files to configure your Docker services.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

scan-to-paperless-0.9.0.dev20200115.tar.gz (5.7 kB view details)

Uploaded Source

Built Distribution

scan_to_paperless-0.9.0.dev20200115-py2.py3-none-any.whl (6.9 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file scan-to-paperless-0.9.0.dev20200115.tar.gz.

File metadata

  • Download URL: scan-to-paperless-0.9.0.dev20200115.tar.gz
  • Upload date:
  • Size: 5.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/44.0.0 requests-toolbelt/0.8.0 tqdm/4.41.1 CPython/3.6.10

File hashes

Hashes for scan-to-paperless-0.9.0.dev20200115.tar.gz
Algorithm Hash digest
SHA256 cbc53158cbc9e139225033eabf8278e3a0a948fa6a4b35d1bac10a4c1f222f5e
MD5 eb511d12746b0e2ada0b628254bca538
BLAKE2b-256 007d54602af6ba6e0832340acbce60407ff22c2322460ca39cabe04dd557f089

See more details on using hashes here.

Provenance

File details

Details for the file scan_to_paperless-0.9.0.dev20200115-py2.py3-none-any.whl.

File metadata

  • Download URL: scan_to_paperless-0.9.0.dev20200115-py2.py3-none-any.whl
  • Upload date:
  • Size: 6.9 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/44.0.0 requests-toolbelt/0.8.0 tqdm/4.41.1 CPython/3.6.10

File hashes

Hashes for scan_to_paperless-0.9.0.dev20200115-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f506732b2ae38a8ee44f0146828749ab8c5b9b0bafe4c7fd6404dd4d04634d04
MD5 850abba03de71c0eedd715d37c727b89
BLAKE2b-256 1da6f320ddd9c0b18b17689e3287138191d3b0af2b0c2ccd466c0e3ae7154ee1

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page