add mega-linter action

.cspell.json

@@ -0,0 +1,56 @@
+{
+  "version": "0.2",
+  "language": "en",
+  "ignorePaths": [
+    "**/node_modules/**",
+    "**/vscode-extension/**",
+    "**/.git/**",
+    "**/.pnpm-lock.json",
+    ".vscode",
+    "package-lock.json",
+    "megalinter-reports"
+  ],
+  "words": [
+    "Brickstore",
+    "PYLINT",
+    "Rebrickable",
+    "abricks",
+    "adduser",
+    "assortedbricks",
+    "autoremove",
+    "beautifulsoup",
+    "brickarchitect",
+    "brickstorexml",
+    "chapternav",
+    "directroy",
+    "dotenv",
+    "enctype",
+    "gethostname",
+    "hirarchy",
+    "inputinterface",
+    "kmeans",
+    "ldcadpbg",
+    "liveconsole",
+    "lxml",
+    "optionnaly",
+    "partid",
+    "pycache",
+    "pyenv",
+    "pylintrc",
+    "pyproject",
+    "pyrightconfig",
+    "pysqlite",
+    "pyyaml",
+    "rebrickable",
+    "rebrickablecsv",
+    "rebrickablejson",
+    "rebrickableset",
+    "scikit",
+    "sqlalchemy",
+    "stefanzweifel",
+    "subarray",
+    "temporpary",
+    "venv",
+    "virtualenv"
+  ]
+}

.github/workflows/mega-linter.yml

@@ -0,0 +1,172 @@
+# MegaLinter GitHub Action configuration file
+# More info at https://megalinter.io
+---
+name: MegaLinter
+
+# Trigger mega-linter at every push. Action will also be visible from Pull
+# Requests to main
+on: # yamllint disable-line rule:truthy - false positive
+  # Comment this line to trigger action only on pull-requests
+  # (not recommended if you don't pay for GH Actions)
+  push:
+
+  pull_request:
+    branches:
+      - main
+      - master
+
+# Comment env block if you do not want to apply fixes
+env:
+  # Apply linter fixes configuration
+  #
+  # When active, APPLY_FIXES must also be defined as environment variable
+  # (in github/workflows/mega-linter.yml or other CI tool)
+  APPLY_FIXES: all
+
+  # Decide which event triggers application of fixes in a commit or a PR
+  # (pull_request, push, all)
+  APPLY_FIXES_EVENT: pull_request
+
+  # If APPLY_FIXES is used, defines if the fixes are directly committed (commit)
+  # or posted in a PR (pull_request)
+  APPLY_FIXES_MODE: commit
+
+concurrency:
+  group: ${{ github.ref }}-${{ github.workflow }}
+  cancel-in-progress: true
+
+permissions: {}
+
+jobs:
+  megalinter:
+    name: MegaLinter
+    runs-on: ubuntu-latest
+
+    # Give the default GITHUB_TOKEN write permission to commit and push, comment
+    # issues & post new PR; remove the ones you do not need
+    permissions:
+      contents: write
+      issues: write
+      pull-requests: write
+
+    steps:
+      # Git Checkout
+      - name: Checkout Code
+        uses: actions/checkout@v5
+        with:
+          token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
+
+          # If you use VALIDATE_ALL_CODEBASE = true, you can remove this line to
+          # improve performance
+          fetch-depth: 0
+
+      # MegaLinter
+      - name: MegaLinter
+
+        # You can override MegaLinter flavor used to have faster performances
+        # More info at https://megalinter.io/latest/flavors/
+        uses: oxsecurity/megalinter@62c799d895af9bcbca5eacfebca29d527f125a57
+
+        id: ml
+
+        # All available variables are described in documentation
+        # https://megalinter.io/latest/configuration/
+        env:
+          # Validates all source when push on main, else just the git diff with
+          # main. Override with true if you always want to lint all sources
+          #
+          # To validate the entire codebase, set to:
+          # VALIDATE_ALL_CODEBASE: true
+          #
+          # To validate only diff with main, set to:
+          # VALIDATE_ALL_CODEBASE: >-
+          #   ${{
+          #     github.event_name == 'push' &&
+          #     contains(fromJSON('["refs/heads/main", "refs/heads/master"]'), github.ref)
+          #   }}
+          VALIDATE_ALL_CODEBASE: true
+
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+          # ADD YOUR CUSTOM ENV VARIABLES HERE OR DEFINE THEM IN A FILE
+          # .mega-linter.yml AT THE ROOT OF YOUR REPOSITORY
+
+          # Uncomment to disable copy-paste and spell checks
+          # DISABLE: COPYPASTE,SPELL
+
+      # Upload MegaLinter artifacts
+      - name: Archive production artifacts
+        if: success() || failure()
+        uses: actions/upload-artifact@v4
+        with:
+          name: MegaLinter reports
+          include-hidden-files: "true"
+          path: |
+            megalinter-reports
+            mega-linter.log
+
+      # Set APPLY_FIXES_IF var for use in future steps
+      - name: Set APPLY_FIXES_IF var
+        run: |
+          printf 'APPLY_FIXES_IF=%s\n' "${{
+            steps.ml.outputs.has_updated_sources == 1 &&
+            (
+              env.APPLY_FIXES_EVENT == 'all' ||
+              env.APPLY_FIXES_EVENT == github.event_name
+            ) &&
+            (
+              github.event_name == 'push' ||
+              github.event.pull_request.head.repo.full_name == github.repository
+            )
+          }}" >> "${GITHUB_ENV}"
+
+      # Set APPLY_FIXES_IF_* vars for use in future steps
+      - name: Set APPLY_FIXES_IF_* vars
+        run: |
+          printf 'APPLY_FIXES_IF_PR=%s\n' "${{
+            env.APPLY_FIXES_IF == 'true' &&
+            env.APPLY_FIXES_MODE == 'pull_request'
+          }}" >> "${GITHUB_ENV}"
+          printf 'APPLY_FIXES_IF_COMMIT=%s\n' "${{
+            env.APPLY_FIXES_IF == 'true' &&
+            env.APPLY_FIXES_MODE == 'commit' &&
+            (!contains(fromJSON('["refs/heads/main", "refs/heads/master"]'), github.ref))
+          }}" >> "${GITHUB_ENV}"
+
+      # Create pull request if applicable
+      # (for now works only on PR from same repository, not from forks)
+      - name: Create Pull Request with applied fixes
+        uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e
+        id: cpr
+        if: env.APPLY_FIXES_IF_PR == 'true'
+        with:
+          token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
+          commit-message: "[MegaLinter] Apply linters automatic fixes"
+          title: "[MegaLinter] Apply linters automatic fixes"
+          labels: bot
+
+      - name: Create PR output
+        if: env.APPLY_FIXES_IF_PR == 'true'
+        run: |
+          echo "PR Number - ${{ steps.cpr.outputs.pull-request-number }}"
+          echo "PR URL - ${{ steps.cpr.outputs.pull-request-url }}"
+
+      # Push new commit if applicable
+      # (for now works only on PR from same repository, not from forks)
+      - name: Prepare commit
+        if: env.APPLY_FIXES_IF_COMMIT == 'true'
+        run: sudo chown -Rc $UID .git/
+
+      - name: Commit and push applied linter fixes
+        uses: stefanzweifel/git-auto-commit-action@28e16e81777b558cc906c8750092100bbb34c5e3
+        if: env.APPLY_FIXES_IF_COMMIT == 'true'
+        with:
+          branch: >-
+            ${{
+              github.event.pull_request.head.ref ||
+              github.head_ref ||
+              github.ref
+            }}
+          commit_message: "[MegaLinter] Apply linters fixes"
+          commit_user_name: megalinter-bot
+          commit_user_email: 129584137+megalinter-bot@users.noreply.github.com

.gitignore

@@ -23,4 +23,7 @@ __pycache__/
 # virtualenv
 .venv
 venv/
-ENV/
+ENV/
+
+# lint
+megalinter-reports/

.jscpd.json

@@ -0,0 +1,3 @@
+{
+  "ignore": ["**/assortedbricks/input/**"]
+}

.mega-linter.yml

@@ -0,0 +1,5 @@
+DISABLE_LINTERS:
+  - REPOSITORY_GRYPE
+
+PYTHON_BANDIT_CONFIG_FILE: pyproject.toml
+PYTHON_PYLINT_CONFIG_FILE: pyproject.toml

Dockerfile

@@ -1,12 +1,22 @@
 FROM python:3-slim
 
-WORKDIR /usr/src/assortedbricks
+RUN adduser abricks
 
-COPY requirements.txt ./
-RUN pip install --no-cache-dir -r requirements.txt
+WORKDIR /home/abricks
 
 COPY . .
 
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    build-essential=12.12 \
+    && pip install --no-cache-dir -r requirements.txt \
+    && apt-get --purge -y autoremove build-essential \
+    && rm -rf /var/lib/apt/lists/*
+
+
+USER abricks
+
+HEALTHCHECK CMD bash -c "exec 6<> /dev/tcp/localhost/5000"
+
 CMD [ "./run-assortedbricks" ]
 
 EXPOSE 5000

README.md

@@ -10,34 +10,34 @@ I found [brickarchitect](https://brickarchitect.com/), and it provided the perfe
 
 ## Installation
 
-```
+```bash
 python3 -m venv .env
 source .env/bin/activate
 pip install -r requirements.txt
 ```
 
 ## Usage
 
-```
+```bash
 source .env/bin/activate
-./run-assortedbrick
+./run-assortedbricks
 ```
 
-Then connect to ```http://localhost:5000``` 
+Then connect to ```http://localhost:5000```
 
 Give a set number or choose an inventory file, the number of clusters to generate and optionnaly a seed for the clustering algorithm.
 
 The set number input is only available is a Rebrickable API key has been configured in the ``config.yaml`` file:
 
-``
+```yaml
 rebrickable-key: "KEY"
-``
+```
 
 Supported file formats are:
- - Rebrickable CSV
- - Brickstore XML
- - LDCad PBG
+- Rebrickable CSV
+- Brickstore XML
+- LDCad PBG
 
 ## Acknowledgement
 
-Special thanks to [brickarchitect](https://brickarchitect.com/) for the excellent data.
+Special thanks to [brickarchitect](https://brickarchitect.com/) for the excellent data.

assortedbricks/__main__.py

@@ -20,12 +20,12 @@
 #
 # SPDX-License-Identifier: MIT
 """
-    The main entry point of assortedbricks
+The main entry point of assortedbricks
 """
 
-from assortedbricks import main
+from .assortedbricks import main
 
-__license__ = 'MIT'
-__copyright__ = 'Copyright (c) 2025, BriocheSoft'
+__license__ = "MIT"
+__copyright__ = "Copyright (c) 2025, BriocheSoft"
 
 main()