OMRChecker v2.0.0

.devcontainer/Dockerfile

@@ -0,0 +1,28 @@
+ARG UV_VERSION=latest
+ARG PYTHON_VERSION=3.11-bullseye
+
+
+FROM ghcr.io/astral-sh/uv:$UV_VERSION AS uv
+
+
+FROM mcr.microsoft.com/vscode/devcontainers/python:$PYTHON_VERSION
+LABEL maintainer="udayraj123 <[email protected]>"
+
+# hadolint ignore=DL3008
+RUN export DEBIAN_FRONTEND=noninteractive \
+    export OMR_CHECKER_CONTAINER=true \
+    && apt-get update \
+    && apt-get install -y --no-install-recommends \
+    # For OpenCV etc...
+    libgl1 libglib2.0-0 \
+    # For numpy, etc
+    gcc \
+    # To remove the image size, it is recommended refresh the package cache as follows
+    && apt-get clean \
+    && rm -rf /var/lib/apt/lists/*
+
+COPY --from=uv --chown=vscode /uv /uvx /bin/
+
+# Note: "postCreateCommand" and "postStartCommand" handle this
+# RUN uv sync --frozen --no-install-project
+# ENTRYPOINT ["./run-devcontainer.sh"]

.devcontainer/devcontainer.json

@@ -0,0 +1,64 @@
+{
+    "name": "uv",
+    "build": {
+        "context": "..",
+        "dockerfile": "Dockerfile",
+        "args": {
+            "BUILDKIT_INLINE_CACHE": "0",
+            "PYTHON_VERSION": "3.11-bullseye",
+            "UV_VERSION": "latest"
+        }
+    },
+    "features": {
+        "ghcr.io/dhoeric/features/hadolint:1": {}
+        // https://github.com/iansan5653/open-mcr/commit/2187c80983266a02220d0f77c835d92112ef792f
+        // "ghcr.io/devcontainers/features/desktop-lite:1": {
+        // 	"version": "latest",
+        // 	"noVncVersion": "1.2.0",
+        // 	"password": "vscode",
+        // 	"webPort": "6080",
+        // 	"vncPort": "5901"
+        // }
+    },
+    // "forwardPorts": [6080],
+    "customizations": {
+        "codespaces": {
+            "openFiles": [
+                "main.py",
+                "README.md"
+            ]
+        },
+        "vscode": {
+            "extensions": [
+                "charliermarsh.ruff",
+                "exiasr.hadolint",
+                // "github.copilot.chat.codeGeneration.instructions",
+                "kevinrose.vsc-python-indent",
+                "ms-azuretools.vscode-docker",
+                "ms-python.python",
+                "ms-python.vscode-pylance",
+                "mutantdino.resourcemonitor",
+                "njpwerner.autodocstring",
+                "redhat.vscode-yaml",
+                "shardulm94.trailing-spaces",
+                "tamasfe.even-better-toml",
+                "yzhang.markdown-all-in-one"
+            ]
+        }
+    },
+    "containerEnv": {
+        "DISPLAY": "dummy",
+        "PYTHONUNBUFFERED": "True",
+        "UV_LINK_MODE": "copy",
+        "UV_PROJECT_ENVIRONMENT": "/home/vscode/.venv"
+    },
+    // https://code.visualstudio.com/docs/devcontainers/tips-and-tricks#_persisting-user-profile
+    "mounts": [
+        "source=profile,target=/root,type=volume",
+        "target=/root/.vscode-server,type=volume"
+    ],
+    "postCreateCommand": "uv sync --frozen",
+    // "postCreateCommand": "pip3 install -r requirements.txt && sudo apt-get update && sudo apt-get -y install python3-opencv python3-tk"
+    "postStartCommand": "uv run pre-commit install",
+    "remoteUser": "vscode"
+}

.dockerignore

@@ -0,0 +1,206 @@
+# OMRChecker inputs and outputs (large directories)
+inputs
+samples
+outputs
+htmlcov
+
+
+# Additional OMRChecker specific exclusions
+OMRChecker.wiki
+mkdocs.yml
+docs
+scripts/local
+*.log
+pytestdebug.log
+pytest.ini
+uv.lock
+
+
+# Byte-compiled / optimized / DLL files
+**/__pycache__/
+**/*.py[cod]
+**/*$py.class
+
+# C extensions
+**/*.so
+
+# Distribution / packaging
+**/.Python
+**/build/
+**/develop-eggs/
+**/dist/
+**/downloads/
+**/eggs/
+**/.eggs/
+**/lib/
+**/lib64/
+**/parts/
+**/sdist/
+**/var/
+**/wheels/
+**/share/python-wheels/
+**/*.egg-info/
+**/.installed.cfg
+**/*.egg
+**/MANIFEST
+
+# Docker
+**/compose.yml
+**/docker-compose.yml
+**/*Dockerfile
+.dockerignore
+
+# Git
+.git
+.github
+**/.gitignore
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+**/*.manifest
+**/*.spec
+
+# Installer logs
+**/pip-log.txt
+**/pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+**/htmlcov/
+**/.tox/
+**/.nox/
+**/.coverage
+**/.coverage.*
+**/.*cache
+**/nosetests.xml
+**/coverage.xml
+**/*.cover
+**/*.py,cover
+**/.hypothesis/
+**/.pytest_cache/
+**/cover/
+
+# Translations
+**/*.mo
+**/*.pot
+
+# Django stuff:
+**/*.log
+**/local_settings.py
+**/db.sqlite3
+**/db.sqlite3-journal
+
+# Flask stuff:
+**/instance/
+**/.webassets-cache
+
+# Scrapy stuff:
+**/.scrapy
+
+# Sphinx documentation
+**/docs/_build/
+
+# PyBuilder
+**/.pybuilder/
+**/target/
+
+# Jupyter Notebook
+**/.ipynb_checkpoints
+
+# IPython
+**/profile_default/
+**/ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+**/__pypackages__/
+
+# Celery stuff
+**/celerybeat-schedule
+**/celerybeat.pid
+
+# SageMath parsed files
+**/*.sage.py
+
+# Environments
+**/.env
+**/.venv
+**/env/
+**/venv/
+**/ENV/
+**/env.bak/
+**/venv.bak/
+
+# Spyder project settings
+**/.spyderproject
+**/.spyproject
+
+# Rope project settings
+**/.ropeproject
+
+# mkdocs documentation
+**/site
+**/docs
+
+
+# mypy
+**/.mypy_cache/
+**/.dmypy.json
+**/dmypy.json
+
+# Pyre type checker
+**/.pyre/
+
+# pytype static type analyzer
+**/.pytype/
+
+# Cython debug symbols
+**/cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# VS Code
+.vscode
+.devcontainer
+
+# Custom
+.pre-commit-config.yaml
+assets
+LICENSE
+pyrightconfig.json
+README.md
+ruff.toml
+tests

.github/actions/setup-git-config/action.yml

@@ -0,0 +1,20 @@
+name: Configure Git Credentials
+description: |
+  This GitHub Action sets the Git user name and user email.
+
+inputs:
+  name:
+    description: Git user name
+    required: true
+  email:
+    description: Git user email
+    required: true
+
+runs:
+  using: composite
+  steps:
+    - name: Sets the Git user name and user email
+      run: |
+        git config user.name github-actions[bot]
+        git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      shell: bash