Skip to main content

Splits a pdf consisting of multiple exams identified by a QR code on the cover page

Project description

split_qr_exam

This program splits a pdf composed of scanned exams. The input is a pdf file containing multiple scanned exames. On each exam cover there should be a QR code identifying the student writing this exam. For each part of the exam a folder will be created and for each student a pdf will be created in that folder to allow for parallel evaluation. To ensure pseudonymity the files are named with the sha256 hash of the student id.

For this to work, you have to specify all the parts of the exam with the corresponding amount of pages.

Install

The program can be installed using pip

To get the latest release from PyPI

pip install split_qr_exam

To get the latest development snapshot

pip install git+https://github.com/christofsteel/split_qr_exam.git

Both will also install all needed requirements, namely pymupdf and python-opencv2-headless. Note: This will install the command split_qr_exam system wide. If you only want to install it as the current user, you should add --user to the pip install commands.

Usage

usage: split_qr_exam [-h] [-t THRESHOLD] [-s SHRINK] [-c CROP] [-T] [-S] [-C] -p PART [-d] [-b] pdf [dest]

Split a scanned examfile into folders for each student and tasks in seperate pdf files. The input PDF should have a QR code identifying the student on the cover of each exam.

positional arguments:
  pdf                   The pdf file to split
  dest                  Destination folder. Default is the current directory

optional arguments:
  -h, --help            show this help message and exit
  -t THRESHOLD, --threshold THRESHOLD
                        Set the threshold for the cleanup phase. Values range from 0 to 255. Lower value means more grey is detected as white, higher value means more grey is detected as black. Only impacts the QR detection phase. Default: 127
  -s SHRINK, --shrink SHRINK
                        Width of the image in pixel for the QR code detection phase. Lower value means more performance, higher value means more accuracy. Only impacts the QR detection phase, does not affect the output PDF. Default: 600
  -c CROP, --crop CROP  Fractional coordinates, that represent the area of the coverpage, where the QR code is located. The format is "x1,y1:x2,y2" where x1, x2, y1, y2 are values from 0 to 1. Default is "0,0.5:0.5,1" which corresponds to the top right
                        quartal of the image.
  -T, --no-cleanup      Skip cleanup phase
  -S, --no-shrink       Skip shrinking phase
  -C, --no-crop         Skip cropping phase
  -p PART, --part PART  Name and amount of pages for the parts of the exam, seperated by a colon. Can (and should) be issued multiple times (Example "-p Cover:1 -p Task1:2"). Should also include a part for the cover sheet, and empty bonus sheets. The
                        number of pages should not include the backsides, if the document is scanned in duplex. Use --is-double-sided instead
  -d, --is-double-sided
                        The exam is scanned in duplex. The split output pdf will also include the last backside of the previous part, since students tend to also write solutions there
  -b, --last-part-is-bonus
                        The last part are bonus sheets. There will be a seperate pdf for each bonus sheet.

Example of use:
        split_qr_exam -p cover:1 -p task1:2 -p task2:3 -p task3:1 -p bonus:3 -b -d scanned_exams.pdf ~/splitexams/

Project details


Download files

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

Source Distribution

split_qr_exam-0.1.1.tar.gz (10.7 kB view details)

Uploaded Source

Built Distribution

split_qr_exam-0.1.1-py3-none-any.whl (22.4 kB view details)

Uploaded Python 3

File details

Details for the file split_qr_exam-0.1.1.tar.gz.

File metadata

  • Download URL: split_qr_exam-0.1.1.tar.gz
  • Upload date:
  • Size: 10.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.8.3

File hashes

Hashes for split_qr_exam-0.1.1.tar.gz
Algorithm Hash digest
SHA256 5b62ca4bece270b5017985026751e4a6cb5aae68adfb89045f78b0a7f52732b1
MD5 fb789d599dd5748f58d9ae755d51cc86
BLAKE2b-256 c3200af4bd51ca0abd21066f2ecf2b6eee773c94113dae9da8c8922385439363

See more details on using hashes here.

File details

Details for the file split_qr_exam-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: split_qr_exam-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 22.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.8.3

File hashes

Hashes for split_qr_exam-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 46be7267ec3083b6e3f80d6ce62e60b440af894647e559e1be35c52291207f5b
MD5 17d65dda389015a4a0c149ca0ec896e7
BLAKE2b-256 f767a44a1214481553a7814e51ba2863d6823189d1134088a54332aeeca6a086

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