Skip to content

Commit 00ffdd1

Browse files
committed
updated docs with examples
1 parent 96b8517 commit 00ffdd1

File tree

2 files changed

+3
-35
lines changed

2 files changed

+3
-35
lines changed

EXTENDING.md

Lines changed: 2 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -131,38 +131,5 @@ if __name__ == "__main__":
131131
```
132132

133133
## external plugins
134-
Plugins can be added and installed in the same env as node-scraper by following the
135-
next steps:
136-
1. Define your pyproject.toml in the right namespace `ext-nodescraper-plugins`:
137-
```
138-
[project]
139-
name = "ext-nodescraper-plugins"
140-
version = "0.1.0"
141-
requires-python = ">=3.10"
142-
dependencies = ["node-scraper"]
143-
144-
[build-system]
145-
requires = ["setuptools", "wheel"]
146-
build-backend = "setuptools.build_meta"
147-
```
148-
149-
2. Define your plugins:
150-
```
151-
(project root)
152-
├─ pyproject.toml
153-
└─ ext_nodescraper_plugins/
154-
├─ __init__.py
155-
└─ sample_plugin/
156-
├─ __init__.py
157-
└─ sample_plugin.py
158-
```
159-
160-
3. Install your plugin in the same env as node-scraper:
161-
```
162-
pip install -e .
163-
```
164-
165-
4. Double check that the external plugin is getting picked up by:
166-
```
167-
node-scraper run-plugins -h
168-
```
134+
External plugins can be added and installed in the same env as node-scraper plugins. Find an
135+
example of an external plugin in **`/docs/node-scraper-external`**

docs/node-scraper-external

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Subproject commit f72dc52e045f29ec95e4abb1b4da55638eda7b37

0 commit comments

Comments
 (0)