Reference Model V1.0

.github/workflows/linting_all_files.yml

@@ -0,0 +1,25 @@
+name: Linting All on Pull Request
+
+on:
+  pull_request:
+    types: [closed]
+
+jobs:
+  lintAllonPR: 
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+
+    - name: Install Dependencies
+      run: |
+        pip install pylint
+
+    - name: Fetch Main
+      run: |
+        git fetch origin main
+        git diff --name-only origin/main..HEAD 
+
+    - name: Run pylint on all files
+      run: |
+        find . -name "*.py" -exec pylint {} +

.github/workflows/linting_modified_files.yml

@@ -0,0 +1,32 @@
+name: Linting on Pull Request
+
+on:
+  pull_request:
+    types: [opened,synchronize]
+
+jobs:
+  lintonPR: 
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+
+    - name: Install Dependencies
+      run: |
+        pip install pylint
+
+    - name: Fetch Main
+      run: |
+        git fetch origin main
+        git diff --name-only origin/main..HEAD 
+
+    - name: Run pylint on modified files
+      run: |
+        changed_files=$(git diff --name-only origin/main..HEAD | grep ".py$")
+        if [ "$changed_files" ]; then
+          echo "Running pylint on changed files:"
+          echo "$changed_files"
+          echo "$changed_files" | xargs pylint
+        else
+          echo "No Python files have been changed."
+        fi

.gitignore

@@ -0,0 +1,131 @@
+# 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/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# 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/
+
+# 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
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.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
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__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
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+.vscode

.pre-commit-config.yaml

@@ -0,0 +1,8 @@
+repos:
+- repo: local
+  hooks:
+  -   id: pylint
+      name: Pylint
+      entry: cmd /c "pylint > pylint.log"
+      files: \.(py)$
+      language: system

.pylintrc

@@ -0,0 +1,11 @@
+[MESSAGES CONTROL]
+disable=unsubscriptable-object,E1136, E1137, R,E0401, C3001, E1121, E0001, C0209,  W1514, C0302, W0621, W0201, C0413
+
+# E0401: Unable to import 'util.utils' (import-error)
+# C3001: Lambda expression assigned to a variable. 
+#        Define a function using the "def" keyword instead. (unnecessary-lambda-assignment)
+# E1121: Too many positional arguments for method call (too-many-function-args)
+# C0302: Too many lines in module (too-many-lines)
+# W0621: Redefining name 'x' from outer scope (redefined-outer-name)
+# W0201: Attribute 'x' defined outside __init__ (attribute-defined-outside-init)
+# C0413: Import "import infinite_isp" should be placed at the top of the module (wrong-import-position)