Skip to content

Commit 0636dca

Browse files
Merge branch 'development' into dwiddows-workflow-fix
2 parents ecaf8e6 + 4bec73e commit 0636dca

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,27 @@ a python virtual environment and also configures the pre-commit hooks for the pr
3232
source dev-setup.sh
3333
```
3434

35+
Alternatively, follow these manual steps:
36+
37+
### 1. Virtual Environment (Optional)
38+
```sh
39+
python3 -m venv venv
40+
source venv/bin/activate
41+
```
42+
On Debian/Ubuntu, you may need: `sudo apt install python3-venv`
43+
44+
### 2. Install from Source (Required)
45+
```sh
46+
python3 -m pip install --editable .[dev] --upgrade
47+
```
48+
This installs Node Scraper in editable mode with development dependencies. To verify: `node-scraper --help`
49+
50+
### 3. Git Hooks (Optional)
51+
```sh
52+
pre-commit install
53+
```
54+
Sets up pre-commit hooks for code quality checks. On Debian/Ubuntu, you may need: `sudo apt install pre-commit`
55+
3556
## CLI Usage
3657
The Node Scraper CLI can be used to run Node Scraper plugins on a target system. The following CLI
3758
options are available:

0 commit comments

Comments
 (0)