BlocksScreen cumulative update V1.0.0

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -0,0 +1,67 @@
+---
+name: Pull Request
+about: Propose code changes
+title: ''
+labels: '' 
+assignees: ''
+
+---
+
+# PR Checklist (Delete the section after checking everything)
+
+- [ ] Make sure you are requesting to PR **feature/bugfix/refactor branch**.
+- [ ] Make sure you are making the pull request against the **dev** branch. 
+- [ ] Make sure you include labels to the PR 
+- [ ] Request a reviewer for the current PR 
+- [ ] After the PR is published, make sure you view the tests conducted by github actions, download artifacts and inspect them. Failure to pass the tests will result in a request for changes.
+
+
+
+# Description 
+
+Select the type: 
+- [ ] Feature
+- [ ] Bug fix
+- [ ] Code refactor
+- [ ] Documentation
+
+Include a summary of the changes made in this PR and which issue is fixed. 
+
+If the current PR is related to a bug introduced in another PR please insert the reference of the previous PR with **#<pr number\>**.
+
+
+Add a concise checklist of the implemented changes, as exemplified below.
+
+- Change 1.
+- Change 2. 
+- Change 3. 
+- ...
+
+
+**Depending on the type of change the current PR relates to, delete sections that are not applicable.**
+
+
+# Motivation
+
+Include a detailed explanation for the current PR. Delete section if not applicable.
+
+# Tests 
+Please describe the conducted tests, and include logs, reports on the tests. 
+
+Also include test configuration.
+
+
+Delete section if not applicable.
+# Screenshots
+
+Include screenshots of the changes. Mostly used for UI changes.
+
+Delete section if not applicable. 
+
+
+# Future work
+
+Emphasize future tasks and improvements tied directly to this pull request. 
+Include only non-breaking changes to this pull request 
+
+Delete section if not applicable.

.github/workflows/dev-ci.yml

@@ -0,0 +1,109 @@
+name: CI-dev-pipeline
+
+on:
+  pull_request:
+    branches:
+      - dev
+    paths-ignore:
+      - "scripts/**"
+      - "BlocksScreen/lib/ui/**"
+      - "extras/**"
+jobs:
+  ci-checks:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11.2"]
+        test-type: [ruff, pylint, pytest, docstrcov, security]
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+          cache-dependency-path: scripts/requirements-dev.txt
+
+      - name: Install dependencies
+        run: |
+          echo "Installing dependencies"
+          python -m pip install --upgrade pip
+          pip install -r scripts/requirements-dev.txt
+
+      - name: Run Test ${{ matrix.test-type }}
+        run: |
+          echo "Starting test runs"
+          if [ "${{ matrix.test-type }}" == "ruff" ]; then 
+            echo "Running Formatting Test"
+            ruff check --output-format=github --target-version=py311 --config=pyproject.toml > ruff-output.txt 2>&1
+            ruff format --diff --target-version=py311 --config=pyproject.toml >> ruff-output.txt 2>&1
+            echo "Ruff finished"
+          fi
+          if [ "${{ matrix.test-type }}" == "pylint" ]; then
+            echo "Running Pylint Code Test"
+            pylint -j$(nproc) --recursive=y BlocksScreen/ > pylint-output.txt 2>&1
+            echo "Pylint finished"
+          fi
+
+          if [ "${{ matrix.test-type }}" == "pytest" ]; then
+            if [ -d "tests/" ] && [ "$(ls -A tests/)" ]; then 
+              echo "Running Python unit tests"
+              pytest tests/ --doctest-modules --junitxml=junit/test-results.xml --cov=BlocksScreen/ --cov-report=xml --cov-report=html > pytest-output.txt 2>&1 
+            else
+              echo "No tests directory no need to proceed with tests"
+            fi
+          fi
+
+          if [ "${{ matrix.test-type }}" == "docstrcov" ]; then 
+            echo "Running docstring coverage test"
+            docstr-coverage BlocksScreen/ --exclude '.*/BlocksScreen/lib/ui/.*?$' --fail-under=80 --skip-magic --skip-init --skip-private --skip-property > docstr-cov-output.txt 2>&1
+          fi
+
+          if [ "${{matrix.test-type }}" == "security" ]; then
+            echo "Running bandit security test"
+            bandit -c pyproject.toml -r . -f json -o bandit-output.json 2>&1
+          fi
+
+      - name: Upload ruff artifact
+        if: always() && matrix.test-type == 'ruff'
+        uses: actions/upload-artifact@v4
+        with:
+          name: ruff-results
+          path: ruff-output.txt
+
+      - name: Upload Pylint Artifacts
+        if: always() && matrix.test-type == 'pylint'
+        uses: actions/upload-artifact@v4
+        with:
+          name: pylint-results
+          path: pylint-output.txt
+
+      - name: Upload Pytest Artifacts
+        if: always() && matrix.test-type == 'pytest'
+        uses: actions/upload-artifact@v4
+        with:
+          name: pytest-results
+          path: |
+            pytest-output.txt
+            junit/test-results.xml
+            coverage.xml
+            htmlcov/
+        continue-on-error: true
+
+      - name: Upload docstr coverage report
+        if: always() && matrix.test-type == 'docstrcov'
+        uses: actions/upload-artifact@v4
+        with:
+          name: docstr-coverage
+          path: docstr-cov-output.txt
+
+      - name: Upload bandit security report
+        if: always() && matrix.test-type == 'security'
+        uses: actions/upload-artifact@v4
+        with:
+          name: bandit-output
+          path: bandit-output.json

.github/workflows/stage-ci.yml

@@ -0,0 +1,23 @@
+name: stage-ci
+
+on: 
+  branches:
+    - stage
+  paths-ignore:
+    - "scripts/**"
+    - "BlocksScreen/lib/ui/**"
+    - "extras/**"
+  workflow_run:
+    workflows: ["dev-test-code"]
+    types:
+      - completed
+  jobs:
+  ci-stage:
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+
+      - name: Run staging pipeline
+        run: echo "Running staging integration tests..."

.pylintrc.dev

@@ -0,0 +1,11 @@
+[MAIN]
+fail-under=7
+jobs=16
+ignore=tests,scripts,ui,extras
+ignore-paths=BlocksScreen/lib/ui
+py-version=3.11
+
+
+[FORMAT]
+max-line-length=88
+

BlocksScreen/BlocksScreen.py

@@ -22,16 +22,15 @@
 RESET = "\033[0m"
 
 
-def setup_working_dir(): ...
-
-
 def setup_app_loggers():
-    ql = logger.create_logger(name="logs/BlocksScreen.log", level=logging.DEBUG)
+    """Setup logger"""
+    _ = logger.create_logger(name="logs/BlocksScreen.log", level=logging.DEBUG)
     _logger = logging.getLogger(name="logs/BlocksScreen.log")
     _logger.info("============ BlocksScreen Initializing ============")
 
 
 def show_splash(window: typing.Optional[QtWidgets.QWidget] = None):
+    """Show splash screen on app initialization"""
     logo = QtGui.QPixmap("BlocksScreen/BlocksScreen/lib/ui/resources/logoblocks.png")
     splash = QtWidgets.QSplashScreen(pixmap=logo)
     splash.setGeometry(QtCore.QRect(0, 0, 400, 200))