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.
## 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.
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
Built Distribution
File details
Details for the file scan-to-paperless-0.5.0.dev20190420.tar.gz.
File metadata
- Download URL: scan-to-paperless-0.5.0.dev20190420.tar.gz
- Upload date:
- Size: 5.7 kB
- Tags: Source
- 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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e8b5722b99a516a10cd96858bab5d212996d36011d8caca728e95913d9ea0b09 |
|
| MD5 | 238aa0acb99e09b39b327f999f5414e6 |
|
| BLAKE2b-256 | 6ff255db3d38dba1ae4136436fe5eb9ccdca39f2d898cbe6f596b5d924cbceb1 |
File details
Details for the file scan_to_paperless-0.5.0.dev20190420-py2.py3-none-any.whl.
File metadata
- Download URL: scan_to_paperless-0.5.0.dev20190420-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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2091eedc82fb0c8af3a523e8ad32c4090d53ffd0125f1877f7ecc82231ec46a5 |
|
| MD5 | fb116a1292fe2224243d022ea591d811 |
|
| BLAKE2b-256 | 27a3292db7a72d9b2d920186ad6df39d90e151cc3a50d259040e994b955e6ba9 |
