OMRChecker v2.0.0

.github/ISSUE_TEMPLATE/bug_report.md

@@ -30,5 +30,5 @@ If applicable, add screenshots to help explain your problem.
 
 **Additional context**
 Add any other context about the problem here.
-
-Error Stack trace. Sample images used, etc
+ - Error Stack trace (using --debug flag).
+ - Sample images used, etc

.github/workflows/github-actions.yml

@@ -0,0 +1,28 @@
+name: CI
+
+on:
+  push:
+    branches: "**"
+  pull_request:
+    branches: "**"
+
+env:
+  OMR_CHECKER_CONTAINER: true
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.x"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.dev.txt
+          pip install pre-commit
+      - name: Run pre-commit
+        run: |
+          pre-commit run

.gitignore

@@ -9,6 +9,9 @@ outputs/*
 
 # Misc
 **/.DS_Store
+**/__ignore__
 **/__pycache__
 venv/
 OMRChecker.wiki/
+pytestdebug.log
+.coverage

.pre-commit-config.yaml

@@ -1,22 +1,68 @@
-exclude: "__snapshots__/.*$"
+exclude: "(__snapshots__|__image_snapshots__)/.*$"
 default_install_hook_types: [pre-commit, pre-push]
 repos:
+  # Convert the pngs to jpgs inside samples folder
+  - repo: local
+    hooks:
+      - id: convert-images
+        name: Convert png to jpg in samples
+        entry: ./scripts/run_python_hook.sh scripts/hooks/convert_images_hook.py
+        args: ["--trigger-size", "150"]
+        files: ^.*\.(png|PNG)$
+        pass_filenames: true
+        stages: [commit]
+        language: script
+        always_run: true
+        fail_fast: true # Wait for user to remove the png files
+
+  # # Run resize image before the compress image check
+  - repo: local
+    hooks:
+      - id: resize-images
+        name: Resize images
+        entry: ./scripts/run_python_hook.sh scripts/hooks/resize_images_hook.py
+        args: ["--max-width", "1500", "--max-height", "1500", "--trigger-size", "150"]
+        files: \.(png|jpg|jpeg|PNG|JPG|JPEG)$
+        pass_filenames: true
+        stages: [commit]
+        language: script
+        always_run: true
+        fail_fast: false
+
+  # Run image compressor before the large files check
+  - repo: https://github.com/boidolr/pre-commit-images
+    rev: v1.5.2
+    hooks:
+      - id: optimize-png
+      - id: optimize-jpg
+        args: ["--quality", "90"]
+        fail_fast: true # Wait for user to commit the files
+
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.4.0
     hooks:
       - id: check-yaml
         stages: [commit]
       - id: check-added-large-files
-        args: ['--maxkb=300']
+        args: ["--maxkb=300"]
         fail_fast: false
         stages: [commit]
       - id: pretty-format-json
-        args: ['--autofix', '--no-sort-keys']
+        args: ["--autofix", "--no-sort-keys"]
       - id: end-of-file-fixer
         exclude_types: ["csv", "json"]
         stages: [commit]
       - id: trailing-whitespace
         stages: [commit]
+
+  # Removes unused imports
+  - repo: https://github.com/pycqa/autoflake
+    rev: v2.3.1
+    hooks:
+      - id: autoflake
+        args: ["--remove-all-unused-imports", "--in-place"]
+        stages: [commit]
+
   - repo: https://github.com/pycqa/isort
     rev: 5.12.0
     hooks:
@@ -34,15 +80,26 @@ repos:
     hooks:
       - id: flake8
         args:
-          - "--ignore=E501,W503,E203,E741,F541" # Line too long, Line break occurred before a binary operator, Whitespace before ':'
+          - "--ignore=E203,E231,E501,E713,E731,E741,F403,F405,F541,W503"
+          # https://www.flake8rules.com/
+          # E203: Whitespace before ':'
+          # E231: missing whitespace after ':'
+          # E501: Line too long
+          # E713: test for membership should be 'not in'
+          # E731: do not assign a lambda expression, use a def
+          # E741: Do not use variables named 'I', 'O', or 'l'
+          # F403: unable to detect undefined names
+          # F405: 'Tuple' may be undefined, or defined from star imports
+          # F541: f-string without any placeholders
+          # W503: Line break occurred before a binary operator
         fail_fast: true
         stages: [commit]
   - repo: local
     hooks:
       - id: pytest-on-commit
         name: Running single sample test
-        entry:  python3 -m pytest -rfpsxEX --disable-warnings --verbose -k sample1
-        language: system
+        entry: ./scripts/run_single_test.sh
+        language: script
         pass_filenames: false
         always_run: true
         fail_fast: true
@@ -51,8 +108,8 @@ repos:
     hooks:
       - id: pytest-on-push
         name: Running all tests before push...
-        entry: python3 -m pytest -rfpsxEX --disable-warnings --verbose --durations=3
-        language: system
+        entry: ./scripts/run_all_tests_and_coverage.sh
+        language: script
         pass_filenames: false
         always_run: true
         fail_fast: true

Contributors.md

@@ -20,3 +20,4 @@
 - [aayushibansal2001](https://github.com/aayushibansal2001)
 - [ShamanthVallem](https://github.com/ShamanthVallem)
 - [rudrapsc](https://github.com/rudrapsc)
+- [palash018](https://github.com/palash018)

README.md

@@ -1,10 +1,10 @@
 # OMR Checker
 
-Read OMR sheets fast and accurately using a scanner 🖨 or your phone 🤳.
+Evaluate OMR sheets fast and accurately using a scanner 🖨 or your phone 🤳.
 
 ## What is OMR?
 
-OMR stands for Optical Mark Recognition, used to detect and interpret human-marked data on documents. OMR refers to the process of reading and evaluating OMR sheets, commonly used in exams, surveys, and other forms.
+OMR stands for Optical Mark Recognition, used to detect and interpret human-marked data on documents. OMR refers to the process of reading and evaluating OMR sheets, commonly used in exams, surveys, and other forms. The OMR sheet scanning is typically done using a scanner, but with OMRChecker it's supported from a mobile camera as well.
 
 #### **Quick Links**
 
@@ -18,7 +18,6 @@ OMR stands for Optical Mark Recognition, used to detect and interpret human-mark
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/Udayraj123/OMRChecker/pull/new/master) <!-- [![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-brightgreen.svg)](https://github.com/Udayraj123/OMRChecker/wiki/TODOs) -->
 [![GitHub pull-requests closed](https://img.shields.io/github/issues-pr-closed/Udayraj123/OMRChecker.svg)](https://github.com/Udayraj123/OMRChecker/pulls?q=is%3Aclosed)
 [![GitHub issues-closed](https://img.shields.io/github/issues-closed/Udayraj123/OMRChecker.svg)](https://GitHub.com/Udayraj123/OMRChecker/issues?q=is%3Aissue+is%3Aclosed)
-[![Ask me](https://img.shields.io/badge/Discuss-on_Github-purple.svg?style=flat-square)](https://github.com/Udayraj123/OMRChecker/issues/5)
 
 <!-- [![GitHub contributors](https://img.shields.io/github/contributors/Udayraj123/OMRChecker.svg)](https://GitHub.com/Udayraj123/OMRChecker/graphs/contributors/) -->
 
@@ -35,9 +34,10 @@ A full-fledged OMR checking software that can read and evaluate OMR sheets scann
 | Specs <img width=200/> | ![Current_Speed](https://img.shields.io/badge/Speed-200+_OMRs/min-blue.svg?style=flat-square) ![Min Resolution](https://img.shields.io/badge/Min_Resolution-640x480-blue.svg?style=flat-square) <img width=200/> |
 | :--------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | 💯 **Accurate**        | Currently nearly 100% accurate on good quality document scans; and about 90% accurate on mobile images.                                                                                                          |
-| 💪🏿 **Robust**          | Supports low resolution, xeroxed sheets. See [**Robustness**](https://github.com/Udayraj123/OMRChecker/wiki/Robustness) for more.                                                                                |
+| 💪🏿 **Robust**          | Supports low resolution, xeroxed sheets as well as colored images. See [**Robustness**](https://github.com/Udayraj123/OMRChecker/wiki/Robustness) for more.                                                      |
 | ⏩ **Fast**            | Current processing speed without any optimization is 200 OMRs/minute.                                                                                                                                            |
 | ✅ **Customizable**    | [Easily apply](https://github.com/Udayraj123/OMRChecker/wiki/User-Guide) to custom OMR layouts, surveys, etc.                                                                                                    |
+| ✅ **Colorful**        | Supports Colored Outputs Since April 2024                                                                                                                                                                        |
 | 📊 **Visually Rich**   | [Get insights](https://github.com/Udayraj123/OMRChecker/wiki/Rich-Visuals) to configure and debug easily.                                                                                                        |
 | 🎈 **Lightweight**     | Very minimal core code size.                                                                                                                                                                                     |
 | 🏫 **Large Scale**     | Tested on a large scale at [Technothlon](https://en.wikipedia.org/wiki/Technothlon).                                                                                                                             |
@@ -342,6 +342,12 @@ Here's a snapshot of the [Android OMR Helper App (archived)](https://github.com/
   <img src="https://contrib.rocks/image?repo=Udayraj123/OMRChecker" />
 </a>
 
+<p align="center">
+
+[![GitHub contributors](https://img.shields.io/github/contributors/Udayraj123/OMRChecker.svg)](https://GitHub.com/Udayraj123/OMRChecker/graphs/contributors/)
+
+</p>
+
 ---
 
 ### License

conftest.py

@@ -0,0 +1,26 @@
+# This will inject the fixture to pytest
+import pytest
+
+from src.tests.__fixtures__.pytest_image_snapshot import (
+    image_snapshot_fixture,
+    image_snapshot_parser_hook,
+)
+from src.tests.__fixtures__.run_sample import run_sample_fixture, run_sample_parser_hook
+
+
+# Register a custom image_snapshot fixture
+@pytest.fixture
+def image_snapshot(request):
+    return image_snapshot_fixture(request)
+
+
+# Register the run_sample fixture
+@pytest.fixture
+def run_sample(request):
+    return run_sample_fixture(request)
+
+
+# Add hook
+def pytest_addoption(parser):
+    run_sample_parser_hook(parser)
+    image_snapshot_parser_hook(parser)

docs/For Contributors.md

@@ -0,0 +1,34 @@
+### Links
+
+- [Contributor Guide](https://github.com/Udayraj123/OMRChecker/blob/master/CONTRIBUTING.md)
+- [Project Ideas List](https://github.com/users/Udayraj123/projects/2/views/1)
+- [Legacy TODOs List](./TODOs)
+
+### 🎯 What can contributors get from this project?
+In order of beginner to expert level: 
+
+🔰 Great learning experience to up your game in computer vision. 
+
+🔰 Intro to Opensource, Working with github
+
+🔰 Visually rich outputs - for learning easily what is happening under the hood.
+
+🔰 Working on large code base with well documented code
+
+🔰 Dedicated Discord channel for doubts as well as open discussions
+
+🔰 Get access to the Android OMR helper application
+
+🔰 Learn Basics like developing an app like camscanner
+
+🔰 Structured way of presenting the working via images. 
+
+🔰 Edge detection using OpenCV (used in self-driving vehicles/robot vision)
+
+🔰 Working with contours (OCR/self-driving vehicles)
+
+🔰 If your PR is accepted, this is a good project to add to your CV. 
+
+🔰 Out of the box use cases of popular techniques : morphology, adaptive threshold, outlier detection, reverse perspective transform, etc.
+
+🔰 Example of when AI/ML cannot easily bring solution to your table, CV never fails to impress!

docs/Home.md

@@ -0,0 +1,34 @@
+Welcome to the OMRChecker wiki!
+
+<!-- Only intro here -->
+
+Click on one of the pages to get started.
+
+## v2 documentation (latest)
+
+<ol>
+<li> <a href="https://github.com/Udayraj123/OMRChecker/wiki/%5Bv1%5D-User-Guide">User Guide</a></li> 
+<li> <a href="https://github.com/Udayraj123/OMRChecker/wiki/%5Bv1%5D-About-Templates">About Templates</a> </li>
+<!-- <li> <a href="https://github.com/Udayraj123/OMRChecker/wiki/%5Bv1%5D-Rich-Visuals">Rich Visuals</a> </li> -->
+<!-- <li> <a href="https://github.com/Udayraj123/OMRChecker/wiki/%5Bv1%5D-Diagrams">Diagrams</a> </li> -->
+</ol>
+
+## v1 documentation
+
+<ol>
+<li><a href="https://github.com/Udayraj123/OMRChecker/wiki/%5Bv1%5D-User-Guide">User Guide</a></li> 
+<li> <a href="https://github.com/Udayraj123/OMRChecker/wiki/%5Bv1%5D-About-Templates">About Templates</a> </li>
+<li> <a href="https://github.com/Udayraj123/OMRChecker/wiki/%5Bv1%5D-Rich-Visuals">Rich Visuals</a> </li>
+<li> <a href="https://github.com/Udayraj123/OMRChecker/wiki/%5Bv1%5D-Diagrams">Diagrams</a> </li>
+</ol>
+
+## Others
+
+<ol>
+<li> <a href="https://github.com/Udayraj123/OMRChecker/wiki/For-Contributors">For Contributors</a> </li>
+<li> <a href="https://github.com/Udayraj123/OMRChecker/wiki/TODOs">TODOs</a> </li>
+</ol>
+
+<!-- ## B.Tech. Project Certificate
+![btp_certificate](<a href="https://raw.githubusercontent.com/wiki/Udayraj123/OMRChecker/extras/Progress/2019-04-26/Certificate.png) -->
+<!-- See full project report here -->

docs/Organization.md

@@ -0,0 +1,7 @@
+# Welcome
+
+Welcome to OMRChecker Organization.
+
+- Please check Project Readme for more details about the project.
+
+- Please check [here](https://github.com/users/Udayraj123/projects/2/views/1) for Project Ideas List.