Skip to main content

A package for matching students to test papers in MarkUs

Project description

MarkUs Exam Matcher

Installation

It is recommended to use a virtual environment to install this package, as it contains many pinned runtime dependencies.

Production Installation (Recommended)

To install the production version of the package, run the following command in the console:

$ pip install markus-exam-matcher --extra-index-url https://download.pytorch.org/whl/cpu

Latest Development Installation

To install the latest development version of the package, run the following command in the console:

$ pip install git+https://github.com/MarkUsProject/markus-exam-matcher.git --extra-index-url https://download.pytorch.org/whl/cpu

Branch Installation

To install the version specified by a particular branch (when permissions are granted), run the following command in the console:

$ pip install git+https://github.com/MarkUsProject/markus-exam-matcher.git@branch_name --extra-index-url https://download.pytorch.org/whl/cpu

Commit Hash Installation

To install the version specified by a specific commit, the commit hash can be used by running the following command in the console:

$ pip install git+https://github.com/MarkUsProject/markus-exam-matcher.git@commit_hash --extra-index-url https://download.pytorch.org/whl/cpu

Usage

This package works under the assumption that the characters to be detected are surrounded by boxes that are placed side-by-side. An example image with this format is displayed below:

Text

Below is a sample usage that generates a prediction from the file shown above.

$ python3 -m markus_exam_matcher --char_type digit char examples/student_info_num.jpg
0001250981

Developers

  1. First, clone this repository.
  2. Open a terminal in this repo, and create a new virtual environment.
  3. Run pip install -e ".[dev]" to install the dependencies.
  4. Then run pre-commit install to install the pre-commit hooks (for automatically formatting and checking your code on each commit).

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

markus_exam_matcher-0.4.0.tar.gz (3.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

markus_exam_matcher-0.4.0-py3-none-any.whl (3.2 MB view details)

Uploaded Python 3

File details

Details for the file markus_exam_matcher-0.4.0.tar.gz.

File metadata

  • Download URL: markus_exam_matcher-0.4.0.tar.gz
  • Upload date:
  • Size: 3.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.0 {"installer":{"name":"uv","version":"0.10.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for markus_exam_matcher-0.4.0.tar.gz
Algorithm Hash digest
SHA256 3ce666c3402bc3769e5e59771bda3e391aa687f09a67e34a35e2c0d32ab0661b
MD5 8c16e3ec16c79e4c1cef2728d9947ab3
BLAKE2b-256 3f9e1d78eaf6822656b01280c47d430209af5274a2ddc5c1e9e842b759f6a399

See more details on using hashes here.

File details

Details for the file markus_exam_matcher-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: markus_exam_matcher-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 3.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.0 {"installer":{"name":"uv","version":"0.10.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for markus_exam_matcher-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3bac4e59e99cb02d43e65107709858bcf0d0170ee06e9ac829dae0b411e513bc
MD5 587b014ab35576b152fcebe56beb2fcf
BLAKE2b-256 8111263f8461171cab5efb2bf822b7ee12d06fb110f6a8f7c22321b4036622a1

See more details on using hashes here.

Supported by

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