Skip to content

README with explicit install steps #61

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alexandraBara merged 8 commits into from
Nov 20, 2025
Merged

README with explicit install steps #61

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
6a3fad8
Add installation instructions and explanations, and deprecate dev-set…
dwiddows Nov 18, 2025
694428f
Slight aligment fix
dwiddows Nov 18, 2025
f1e87d4
Make dev-setup.sh executable
dwiddows Nov 19, 2025
a962828
Merge branch 'development' into dev-setup-fix
dwiddows Nov 19, 2025
41a964b
Merge remote-tracking branch 'origin/development' into dwiddows-setup…
dwiddows Nov 19, 2025
1b97e49
Reverting dev-setup.sh to try and isolate workflow failures
dwiddows Nov 19, 2025
799ad6a
Add debug: show shell being used in workflow
dwiddows Nov 19, 2025
95aed73
Reverted dev-setup.sh making this branch just README changes
dwiddows Nov 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down