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](https://syncthing.net/)).

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.

4. 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).

5. 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.

3. Delete the file `REMOVE_TO_CONTINUE`.

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

5. 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+](https://www.synology.com/products/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.5.0.dev20190407.tar.gz (5.6 kB view details)

Uploaded Source

Built Distributions

scan_to_paperless-0.5.0.dev20190407-py2.py3-none-any.whl (6.6 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file scan-to-paperless-0.5.0.dev20190407.tar.gz.

File metadata

File hashes

Hashes for scan-to-paperless-0.5.0.dev20190407.tar.gz
Algorithm Hash digest
SHA256 898a8bc98e910371e8698c08783e0f2ba17ab445a188a0ca3c127ab50fe45cc1
MD5 8ca2a9416cd99294baf81a5d46d408ba
BLAKE2b-256 7235103360501d40d11574789d16c3c93db385d68b28e3225f9c049c9c01e2a2

See more details on using hashes here.

File details

Details for the file scan_to_paperless-0.5.0.dev20190407-py3-none-any.whl.

File metadata

File hashes

Hashes for scan_to_paperless-0.5.0.dev20190407-py3-none-any.whl
Algorithm Hash digest
SHA256 8c59416814040355eae61591dfbbcd9e4df441353627f1cdb9cf5f79e2446456
MD5 0663cb4746193c044fc362e7330b1b80
BLAKE2b-256 3f1fd92b5abac40f5999741171e7641622df8a5cbc5e2268f2031b42dce95d72

See more details on using hashes here.

File details

Details for the file scan_to_paperless-0.5.0.dev20190407-py2.py3-none-any.whl.

File metadata

  • Download URL: scan_to_paperless-0.5.0.dev20190407-py2.py3-none-any.whl
  • Upload date:
  • Size: 6.6 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.8.0 tqdm/4.31.1 CPython/3.6.8

File hashes

Hashes for scan_to_paperless-0.5.0.dev20190407-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 5331e884900fe10101e2c0241cde3fdeb1f0c217168be6ec53ba0c193371c55e
MD5 fd29d46c8934b7ab01c5559a24d23c03
BLAKE2b-256 9bf9a06a2ebf7aa4ae661c583f741b184b1ba23a984294248b64b8924b5d3902

See more details on using hashes here.

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