From 6a3fad8218e1969d2dd59ecfaabefb57bf91eea6 Mon Sep 17 00:00:00 2001 From: Dominic Widdows Date: Tue, 18 Nov 2025 13:12:38 -0600 Subject: [PATCH 1/6] Add installation instructions and explanations, and deprecate dev-setup.sh to avoid installation errors --- README.md | 21 +++++++++++++++++++++ dev-setup.sh | 15 ++++++++++----- 2 files changed, 31 insertions(+), 5 deletions(-) mode change 100755 => 100644 dev-setup.sh diff --git a/README.md b/README.md index f0b15270..c020fdd1 100644 --- a/README.md +++ b/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: diff --git a/dev-setup.sh b/dev-setup.sh old mode 100755 new mode 100644 index 7cafc606..a5ea5439 --- a/dev-setup.sh +++ b/dev-setup.sh @@ -1,12 +1,17 @@ -# Create venv if not already present +#!/bin/bash + +# Create venv if not present if [ ! -d "venv" ]; then - python3 -m pip install venv - python3 -m venv venv + python3 -m venv venv || { echo "Failed to create venv. Try: sudo apt install python3-venv"; exit 1; } fi -# Activate the desired venv +# Activate venv source venv/bin/activate +# Install package python3 -m pip install --editable .[dev] --upgrade -pre-commit install +# Install pre-commit hooks if available +if command -v pre-commit &> /dev/null; then + pre-commit install +fi From 694428fe77981fcc97837b3c276698867d24c202 Mon Sep 17 00:00:00 2001 From: Dominic Widdows Date: Tue, 18 Nov 2025 17:21:32 -0600 Subject: [PATCH 2/6] Slight aligment fix --- dev-setup.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dev-setup.sh b/dev-setup.sh index a5ea5439..fff7804d 100644 --- a/dev-setup.sh +++ b/dev-setup.sh @@ -5,7 +5,7 @@ if [ ! -d "venv" ]; then python3 -m venv venv || { echo "Failed to create venv. Try: sudo apt install python3-venv"; exit 1; } fi -# Activate venv +# Activate the desired venv source venv/bin/activate # Install package From f1e87d4e85922ef0dc4eae71584a29a632627e74 Mon Sep 17 00:00:00 2001 From: Dominic Widdows Date: Tue, 18 Nov 2025 18:17:02 -0600 Subject: [PATCH 3/6] Make dev-setup.sh executable --- dev-setup.sh | 0 1 file changed, 0 insertions(+), 0 deletions(-) mode change 100644 => 100755 dev-setup.sh diff --git a/dev-setup.sh b/dev-setup.sh old mode 100644 new mode 100755 From 1b97e4980290c439e81bd6407ee8ed82aed05397 Mon Sep 17 00:00:00 2001 From: Dominic Widdows Date: Wed, 19 Nov 2025 15:03:43 -0800 Subject: [PATCH 4/6] Reverting dev-setup.sh to try and isolate workflow failures --- dev-setup.sh | 13 ++++--------- 1 file changed, 4 insertions(+), 9 deletions(-) diff --git a/dev-setup.sh b/dev-setup.sh index fff7804d..7cafc606 100755 --- a/dev-setup.sh +++ b/dev-setup.sh @@ -1,17 +1,12 @@ -#!/bin/bash - -# Create venv if not present +# Create venv if not already present if [ ! -d "venv" ]; then - python3 -m venv venv || { echo "Failed to create venv. Try: sudo apt install python3-venv"; exit 1; } + python3 -m pip install venv + python3 -m venv venv fi # Activate the desired venv source venv/bin/activate -# Install package python3 -m pip install --editable .[dev] --upgrade -# Install pre-commit hooks if available -if command -v pre-commit &> /dev/null; then - pre-commit install -fi +pre-commit install From 799ad6a1bb8a035943b785e314fcb757088d6d2a Mon Sep 17 00:00:00 2001 From: Dominic Widdows Date: Wed, 19 Nov 2025 15:49:17 -0800 Subject: [PATCH 5/6] Add debug: show shell being used in workflow --- dev-setup.sh | 2 ++ 1 file changed, 2 insertions(+) diff --git a/dev-setup.sh b/dev-setup.sh index 7cafc606..83119dd9 100755 --- a/dev-setup.sh +++ b/dev-setup.sh @@ -1,3 +1,5 @@ +echo "Running in shell: $SHELL (process: $(ps -p $$ -o comm=))" + # Create venv if not already present if [ ! -d "venv" ]; then python3 -m pip install venv From 95aed73cc127b68f3fc5b315f1b572b69960955e Mon Sep 17 00:00:00 2001 From: Dominic Widdows Date: Thu, 20 Nov 2025 09:31:01 -0800 Subject: [PATCH 6/6] Reverted dev-setup.sh making this branch just README changes --- dev-setup.sh | 2 -- 1 file changed, 2 deletions(-) diff --git a/dev-setup.sh b/dev-setup.sh index 83119dd9..7cafc606 100755 --- a/dev-setup.sh +++ b/dev-setup.sh @@ -1,5 +1,3 @@ -echo "Running in shell: $SHELL (process: $(ps -p $$ -o comm=))" - # Create venv if not already present if [ ! -d "venv" ]; then python3 -m pip install venv