Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

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.

Metadata

Release files for scan-to-paperless 0.9.0.dev20200128

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for scan-to-paperless 0.9.0.dev20200128
File Size Uploaded Provenance Actions
scan-to-paperless-0.9.0.dev20200128.tar.gz 5.8 kB Without provenance Details for scan-to-paperless-0.9.0.dev20200128.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for scan-to-paperless 0.9.0.dev20200128
File Interpreter ABI Platform Actions
scan_to_paperless-0.9.0.dev20200128-py2.py3-none-any.whl Python 3, Python 2 none any Details for scan_to_paperless-0.9.0.dev20200128-py2.py3-none-any.whl

Total release size: 12.7 kB

Release files / scan-to-paperless-0.9.0.dev20200128.tar.gz

Download URL scan-to-paperless-0.9.0.dev20200128.tar.gz
Size 5.8 kB
Tags Source
SHA-256 checksum
How to use checksums
f02d8bd35bc702ab6a6ac866c9539a09fec90f5ae6e420ad1a53025f2c68045c
BLAKE2b-256 checksum
How to use checksums
419ba3e332b6b53da0e520f4c9da795a8201bafe729dc0cac42085eac63e59a5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.1.0 requests-toolbelt/0.8.0 tqdm/4.42.0 CPython/3.6.10

Release files / scan_to_paperless-0.9.0.dev20200128-py2.py3-none-any.whl

Download URL scan_to_paperless-0.9.0.dev20200128-py2.py3-none-any.whl
Size 6.9 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
e3049fa533bc38b7f89ae72866d1190fab2270e2fb69c63d2d0ae2b157d0d60a
BLAKE2b-256 checksum
How to use checksums
f96538d92a9fb79462aee6011b420b7f5788feacb71279072f936316ee5136d7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.1.0 requests-toolbelt/0.8.0 tqdm/4.42.0 CPython/3.6.10

Security for scan-to-paperless 0.9.0.dev20200128

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page