Merge branch 'development' into alex_fixes

Author: alexandraBara

.github/workflows/code_quality_checks.yml

@@ -4,7 +4,9 @@ name: Code Quality Check
 permissions:
   contents: read
 
-on: [pull_request]
+on:
+  - pull_request
+  - workflow_dispatch
 
 jobs:
   pre-commit:
@@ -13,11 +15,10 @@ jobs:
 
     steps:
       - uses: actions/checkout@v3
-      - name: setup environment
-        run: |
-          ./dev-setup.sh
-      - name: run pre-commit hooks
+      - name: setup environment and run pre-commit hooks
+        shell: bash
         run: |
+          source ./dev-setup.sh
           pre-commit run --all-files --show-diff-on-failure --color=always
       - name: Print message on failure
         if: failure()

.github/workflows/unit-test.yml

@@ -17,19 +17,16 @@ jobs:
     steps:
     - uses: actions/checkout@v3
 
-    - name: Install package
-      run: |
-        ./dev-setup.sh
-
     - name: Install xmllint
       run: |
         apt-get update
         apt-get install -y libxml2-utils bc
 
-
-    - name: Run unit tests with coverage
+    - name: Install package and run unit tests with coverage
       id: extract_coverage
+      shell: bash
       run: |
+        source ./dev-setup.sh
         pytest test/unit -s --cov=nodescraper --cov-report=xml --cov-report=term --cov-fail-under=70 --maxfail=1 --disable-warnings -v
 
     - name: Print coverage

README.md

@@ -32,6 +32,27 @@ a python virtual environment and also configures the pre-commit hooks for the pr
 source dev-setup.sh
 ```
 
+Alternatively, follow these manual steps:
+
+### 1. Virtual Environment (Optional)
+```sh
+python3 -m venv venv
+source venv/bin/activate
+```
+On Debian/Ubuntu, you may need: `sudo apt install python3-venv`
+
+### 2. Install from Source (Required)
+```sh
+python3 -m pip install --editable .[dev] --upgrade
+```
+This installs Node Scraper in editable mode with development dependencies. To verify: `node-scraper --help`
+
+### 3. Git Hooks (Optional)
+```sh
+pre-commit install
+```
+Sets up pre-commit hooks for code quality checks. On Debian/Ubuntu, you may need: `sudo apt install pre-commit`
+
 ## CLI Usage
 The Node Scraper CLI can be used to run Node Scraper plugins on a target system. The following CLI
 options are available:

dev-setup.sh

@@ -1,6 +1,7 @@
+#!/usr/bin/env bash
+
 # Create venv if not already present
 if [ ! -d "venv" ]; then
-    python3 -m pip install venv
     python3 -m venv venv
 fi