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.3.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.3.0-py3-none-any.whl (3.2 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: markus_exam_matcher-0.3.0.tar.gz
  • Upload date:
  • Size: 3.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.18 {"installer":{"name":"uv","version":"0.9.18","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.3.0.tar.gz
Algorithm Hash digest
SHA256 b94a106b637e9c52c88035e0cd0bfbeb11829b5b90923166a53174fe5f427cc0
MD5 6cb4cea34d26ab1ac093b55944487701
BLAKE2b-256 296ceb0a0e8447ff7736b914ea77605f61622a739df5cc1a4992722acb35f824

See more details on using hashes here.

File details

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

File metadata

  • Download URL: markus_exam_matcher-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 3.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.18 {"installer":{"name":"uv","version":"0.9.18","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.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 accc752f19fe128e8a78e7535f811efef9fbf0b2c3521a31ddda839cab391fc0
MD5 51a3fd6f93614f94163069be44ca0bfe
BLAKE2b-256 55f22010d0c30c20dabb69341a3405a6b7076313e30f9d21728b4c5a26ce8ddc

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