Skip to content

Commit 0a1cf1a

Browse files
VinciGit00claude
andcommitted
docs: refine cookbook notebooks and document release versioning
- Add versioning & release section to CLAUDE.md describing semantic-release commit conventions - Polish company-info, github-trending, and wired-news SDK cookbook notebooks - Refresh uv.lock Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent b80fe30 commit 0a1cf1a

5 files changed

Lines changed: 181 additions & 177 deletions

File tree

CLAUDE.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,20 @@ uv run pytest tests/ -v
5858

5959
No exceptions.
6060

61+
## Versioning & Releases
62+
63+
Use **semantic-release** to manage versions. Prefer **patch bumps (+0.0.1)** as much as possible — reserve minor (+0.1.0) for genuinely new user-facing features and major (+1.0.0) for breaking changes only.
64+
65+
Commit message conventions that drive the bump:
66+
67+
- `fix:` → patch (+0.0.1) — **default choice** for most changes
68+
- `docs:` → patch (+0.0.1) — documentation updates
69+
- `chore:` → patch (+0.0.1) — maintenance, tooling, deps
70+
- `feat:` → minor (+0.1.0) — only for meaningful new features
71+
- `BREAKING CHANGE:` footer or `!` suffix → major (+1.0.0) — only for breaking API changes
72+
73+
When in doubt, frame the change as `fix:`, `docs:`, or `chore:` to keep the bump at patch level.
74+
6175
## Architecture
6276

6377
**Core Components:**

cookbook/company-info/scrapegraph_sdk.ipynb

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@
66
"id": "jEkuKbcRrPcK"
77
},
88
"source": [
9-
"## \ud83d\udd77\ufe0f Extract Company Info with Official Scrapegraph SDK\n",
10-
"\n",
11-
"[![Open in Alph](https://www.runalph.ai/badges/open-in-alph.svg)](https://www.runalph.ai/notebooks/scrapegraphai/scrapegraph-sdk) [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/12d7LycLAYO2bFsBo_jtPHXSaIg7AqR3O?usp=sharing)"
9+
"## 🕷️ Extract Company Info with Official Scrapegraph SDK\n"
1210
]
1311
},
1412
{
@@ -26,7 +24,7 @@
2624
"id": "IzsyDXEWwPVt"
2725
},
2826
"source": [
29-
"### \ud83d\udd27 Install `dependencies`"
27+
"### 🔧 Install `dependencies`"
3028
]
3129
},
3230
{
@@ -47,7 +45,7 @@
4745
"id": "apBsL-L2KzM7"
4846
},
4947
"source": [
50-
"### \ud83d\udd11 Import `ScrapeGraph` API key"
48+
"### 🔑 Import `ScrapeGraph` API key"
5149
]
5250
},
5351
{
@@ -85,7 +83,7 @@
8583
"output_type": "stream",
8684
"text": [
8785
"SGAI_API_KEY not found in environment.\n",
88-
"Please enter your SGAI_API_KEY: \u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\n",
86+
"Please enter your SGAI_API_KEY: ··········\n",
8987
"SGAI_API_KEY has been set in the environment.\n"
9088
]
9189
}
@@ -104,7 +102,7 @@
104102
"id": "jnqMB2-xVYQ7"
105103
},
106104
"source": [
107-
"### \ud83d\udcdd Defining an `Output Schema` for Webpage Content Extraction\n"
105+
"### 📝 Defining an `Output Schema` for Webpage Content Extraction\n"
108106
]
109107
},
110108
{
@@ -198,7 +196,7 @@
198196
"outputs": [],
199197
"source": [
200198
"from pydantic import BaseModel, Field\n",
201-
"from typing import List, Dict, Optional\n",
199+
"from typing import List\n",
202200
"\n",
203201
"# Schema for founder information\n",
204202
"class FounderSchema(BaseModel):\n",
@@ -239,7 +237,7 @@
239237
"id": "cDGH0b2DkY63"
240238
},
241239
"source": [
242-
"### \ud83d\ude80 Initialize `SGAI Client` and start extraction"
240+
"### 🚀 Initialize `SGAI Client` and start extraction"
243241
]
244242
},
245243
{
@@ -420,7 +418,7 @@
420418
"id": "2as65QLypwdb"
421419
},
422420
"source": [
423-
"### \ud83d\udcbe Save the output to a `CSV` file"
421+
"### 💾 Save the output to a `CSV` file"
424422
]
425423
},
426424
{
@@ -1885,7 +1883,7 @@
18851883
"id": "-1SZT8VzTZNd"
18861884
},
18871885
"source": [
1888-
"## \ud83d\udd17 Resources"
1886+
"## 🔗 Resources"
18891887
]
18901888
},
18911889
{
@@ -1901,13 +1899,13 @@
19011899
"</p>\n",
19021900
"\n",
19031901
"\n",
1904-
"- \ud83d\ude80 **Get your API Key:** [ScrapeGraphAI Dashboard](https://dashboard.scrapegraphai.com) \n",
1905-
"- \ud83d\udc19 **GitHub:** [ScrapeGraphAI GitHub](https://github.com/scrapegraphai) \n",
1906-
"- \ud83d\udcbc **LinkedIn:** [ScrapeGraphAI LinkedIn](https://www.linkedin.com/company/scrapegraphai/) \n",
1907-
"- \ud83d\udc26 **Twitter:** [ScrapeGraphAI Twitter](https://twitter.com/scrapegraphai) \n",
1908-
"- \ud83d\udcac **Discord:** [Join our Discord Community](https://discord.gg/uJN7TYcpNa) \n",
1902+
"- 🚀 **Get your API Key:** [ScrapeGraphAI Dashboard](https://dashboard.scrapegraphai.com) \n",
1903+
"- 🐙 **GitHub:** [ScrapeGraphAI GitHub](https://github.com/scrapegraphai) \n",
1904+
"- 💼 **LinkedIn:** [ScrapeGraphAI LinkedIn](https://www.linkedin.com/company/scrapegraphai/) \n",
1905+
"- 🐦 **Twitter:** [ScrapeGraphAI Twitter](https://twitter.com/scrapegraphai) \n",
1906+
"- 💬 **Discord:** [Join our Discord Community](https://discord.gg/uJN7TYcpNa) \n",
19091907
"\n",
1910-
"Made with \u2764\ufe0f by the [ScrapeGraphAI](https://scrapegraphai.com) Team \n"
1908+
"Made with ❤️ by the [ScrapeGraphAI](https://scrapegraphai.com) Team \n"
19111909
]
19121910
}
19131911
],

cookbook/github-trending/scrapegraph_sdk.ipynb

Lines changed: 19 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@
66
"id": "jEkuKbcRrPcK"
77
},
88
"source": [
9-
"## \ud83d\udd77\ufe0f Extract Github Trending Repositories with Official Scrapegraph SDK\n",
10-
"\n",
11-
"[![Open in Alph](https://www.runalph.ai/badges/open-in-alph.svg)](https://www.runalph.ai/notebooks/scrapegraphai/scrapegraph-sdk-1) [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1SSsI0naieeHjHcJkW22CqNIZwLHWjXmd?usp=sharing)"
9+
"## 🕷️ Extract Github Trending Repositories with Official Scrapegraph SDK\n"
1210
]
1311
},
1412
{
@@ -26,7 +24,7 @@
2624
"id": "IzsyDXEWwPVt"
2725
},
2826
"source": [
29-
"### \ud83d\udd27 Install `dependencies`"
27+
"### 🔧 Install `dependencies`"
3028
]
3129
},
3230
{
@@ -47,7 +45,7 @@
4745
"id": "apBsL-L2KzM7"
4846
},
4947
"source": [
50-
"### \ud83d\udd11 Import `ScrapeGraph` API key"
48+
"### 🔑 Import `ScrapeGraph` API key"
5149
]
5250
},
5351
{
@@ -81,11 +79,11 @@
8179
},
8280
"outputs": [
8381
{
84-
"name": "stdin",
82+
"name": "stdout",
8583
"output_type": "stream",
8684
"text": [
8785
"Scrapegraph API key:\n",
88-
" \u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\n"
86+
" ········\n"
8987
]
9088
}
9189
],
@@ -103,7 +101,7 @@
103101
"id": "jnqMB2-xVYQ7"
104102
},
105103
"source": [
106-
"### \ud83d\udcdd Defining an `Output Schema` for Webpage Content Extraction\n"
104+
"### 📝 Defining an `Output Schema` for Webpage Content Extraction\n"
107105
]
108106
},
109107
{
@@ -190,7 +188,7 @@
190188
},
191189
{
192190
"cell_type": "code",
193-
"execution_count": 3,
191+
"execution_count": null,
194192
"metadata": {
195193
"id": "dlrOEgZk_8V4"
196194
},
@@ -221,7 +219,7 @@
221219
"id": "cDGH0b2DkY63"
222220
},
223221
"source": [
224-
"### \ud83d\ude80 Initialize `SGAI Client` and start extraction"
222+
"### 🚀 Initialize `SGAI Client` and start extraction"
225223
]
226224
},
227225
{
@@ -2532,7 +2530,7 @@
25322530
"id": "2as65QLypwdb"
25332531
},
25342532
"source": [
2535-
"### \ud83d\udcbe Save the output to a `CSV` file"
2533+
"### 💾 Save the output to a `CSV` file"
25362534
]
25372535
},
25382536
{
@@ -2689,15 +2687,15 @@
26892687
" <tr>\n",
26902688
" <th>274</th>\n",
26912689
" <td>datawhalechina/hello-agents</td>\n",
2692-
" <td>\ud83d\udcda \u300a\u4ece\u96f6\u5f00\u59cb\u6784\u5efa\u667a\u80fd\u4f53\u300b----\u4ece\u96f6\u5f00\u59cb\u7684\u667a\u80fd\u4f53\u539f\u7406\u4e0e\u5b9e\u8df5\u6559\u7a0b</td>\n",
2690+
" <td>📚 《从零开始构建智能体》----从零开始的智能体原理与实践教程</td>\n",
26932691
" <td>47116</td>\n",
26942692
" <td>5669</td>\n",
26952693
" <td>748</td>\n",
26962694
" <td>Python</td>\n",
26972695
" </tr>\n",
26982696
" </tbody>\n",
26992697
"</table>\n",
2700-
"<p>275 rows \u00d7 6 columns</p>\n",
2698+
"<p>275 rows × 6 columns</p>\n",
27012699
"</div>"
27022700
],
27032701
"text/plain": [
@@ -2725,7 +2723,7 @@
27252723
"271 Self-evolving agent: grows skill tree from 3.3... 10714 1205 \n",
27262724
"272 Unlimited FREE AI coding. Connect Claude Code,... 7644 1262 \n",
27272725
"273 The agent harness performance optimization sys... 178795 27573 \n",
2728-
"274 \ud83d\udcda \u300a\u4ece\u96f6\u5f00\u59cb\u6784\u5efa\u667a\u80fd\u4f53\u300b----\u4ece\u96f6\u5f00\u59cb\u7684\u667a\u80fd\u4f53\u539f\u7406\u4e0e\u5b9e\u8df5\u6559\u7a0b 47116 5669 \n",
2726+
"274 📚 《从零开始构建智能体》----从零开始的智能体原理与实践教程 47116 5669 \n",
27292727
"\n",
27302728
" today_stars language \n",
27312729
"0 0 No content available \n",
@@ -2807,7 +2805,7 @@
28072805
"id": "-1SZT8VzTZNd"
28082806
},
28092807
"source": [
2810-
"## \ud83d\udd17 Resources"
2808+
"## 🔗 Resources"
28112809
]
28122810
},
28132811
{
@@ -2823,13 +2821,13 @@
28232821
"</p>\n",
28242822
"\n",
28252823
"\n",
2826-
"- \ud83d\ude80 **Get your API Key:** [ScrapeGraphAI Dashboard](https://scrapegraphai.com/dashboard) \n",
2827-
"- \ud83d\udc19 **GitHub:** [ScrapeGraphAI GitHub](https://github.com/scrapegraphai) \n",
2828-
"- \ud83d\udcbc **LinkedIn:** [ScrapeGraphAI LinkedIn](https://www.linkedin.com/company/scrapegraphai/) \n",
2829-
"- \ud83d\udc26 **Twitter:** [ScrapeGraphAI Twitter](https://twitter.com/scrapegraphai) \n",
2830-
"- \ud83d\udcac **Discord:** [Join our Discord Community](https://discord.gg/uJN7TYcpNa) \n",
2824+
"- 🚀 **Get your API Key:** [ScrapeGraphAI Dashboard](https://scrapegraphai.com/dashboard) \n",
2825+
"- 🐙 **GitHub:** [ScrapeGraphAI GitHub](https://github.com/scrapegraphai) \n",
2826+
"- 💼 **LinkedIn:** [ScrapeGraphAI LinkedIn](https://www.linkedin.com/company/scrapegraphai/) \n",
2827+
"- 🐦 **Twitter:** [ScrapeGraphAI Twitter](https://twitter.com/scrapegraphai) \n",
2828+
"- 💬 **Discord:** [Join our Discord Community](https://discord.gg/uJN7TYcpNa) \n",
28312829
"\n",
2832-
"Made with \u2764\ufe0f by the [ScrapeGraphAI](https://scrapegraphai.com) Team \n"
2830+
"Made with ❤️ by the [ScrapeGraphAI](https://scrapegraphai.com) Team \n"
28332831
]
28342832
}
28352833
],

cookbook/wired-news/scrapegraph_sdk.ipynb

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@
66
"id": "jEkuKbcRrPcK"
77
},
88
"source": [
9-
"## \ud83d\udd77\ufe0f Extract Wired Science News with Official Scrapegraph SDK\n",
10-
"\n",
11-
"[![Open in Alph](https://www.runalph.ai/badges/open-in-alph.svg)](https://www.runalph.ai/notebooks/scrapegraphai/scrapegraph-sdk-3) [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1HVw8fpLlhfBH0AQetaEy4ObbNiOuYm6g?usp=sharing)"
9+
"## 🕷️ Extract Wired Science News with Official Scrapegraph SDK"
1210
]
1311
},
1412
{
@@ -26,7 +24,7 @@
2624
"id": "IzsyDXEWwPVt"
2725
},
2826
"source": [
29-
"### \ud83d\udd27 Install `dependencies`"
27+
"### 🔧 Install `dependencies`"
3028
]
3129
},
3230
{
@@ -47,7 +45,7 @@
4745
"id": "apBsL-L2KzM7"
4846
},
4947
"source": [
50-
"### \ud83d\udd11 Import `ScrapeGraph` API key"
48+
"### 🔑 Import `ScrapeGraph` API key"
5149
]
5250
},
5351
{
@@ -85,7 +83,7 @@
8583
"output_type": "stream",
8684
"text": [
8785
"SGAI_API_KEY not found in environment.\n",
88-
"Please enter your SGAI_API_KEY: \u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\u00b7\n",
86+
"Please enter your SGAI_API_KEY: ··········\n",
8987
"SGAI_API_KEY has been set in the environment.\n"
9088
]
9189
}
@@ -104,7 +102,7 @@
104102
"id": "jnqMB2-xVYQ7"
105103
},
106104
"source": [
107-
"### \ud83d\udcdd Defining an `Output Schema` for Webpage Content Extraction\n"
105+
"### 📝 Defining an `Output Schema` for Webpage Content Extraction\n"
108106
]
109107
},
110108
{
@@ -218,7 +216,7 @@
218216
"id": "cDGH0b2DkY63"
219217
},
220218
"source": [
221-
"### \ud83d\ude80 Initialize `SGAI Client` and start extraction"
219+
"### 🚀 Initialize `SGAI Client` and start extraction"
222220
]
223221
},
224222
{
@@ -316,7 +314,7 @@
316314
"id": "2as65QLypwdb"
317315
},
318316
"source": [
319-
"### \ud83d\udcbe Save the output to a `CSV` file"
317+
"### 💾 Save the output to a `CSV` file"
320318
]
321319
},
322320
{
@@ -430,7 +428,7 @@
430428
" <tr>\n",
431429
" <th>6</th>\n",
432430
" <td>Health</td>\n",
433-
" <td>RFK Plans to Take on Big Pharma. It\u2019s Easier S...</td>\n",
431+
" <td>RFK Plans to Take on Big Pharma. It’s Easier S...</td>\n",
434432
" <td>https://www.wired.com/story/rfks-plan-to-take-...</td>\n",
435433
" <td>Emily Mullin</td>\n",
436434
" </tr>\n",
@@ -731,7 +729,7 @@
731729
"3 Health Antibodies Could Soon Help Slow the Aging Process \n",
732730
"4 Science Good at Reading? Your Brain May Be Structured ... \n",
733731
"5 Health Mega-Farms Are Driving the Threat of Bird Flu \n",
734-
"6 Health RFK Plans to Take on Big Pharma. It\u2019s Easier S... \n",
732+
"6 Health RFK Plans to Take on Big Pharma. It’s Easier S... \n",
735733
"7 Environment How Christmas Trees Could Become a Source of L... \n",
736734
"8 Environment Creating a Global Package to Solve the Problem... \n",
737735
"9 Environment These 3 Things Are Standing in the Way of a Gl... \n",
@@ -825,7 +823,7 @@
825823
"id": "-1SZT8VzTZNd"
826824
},
827825
"source": [
828-
"## \ud83d\udd17 Resources"
826+
"## 🔗 Resources"
829827
]
830828
},
831829
{
@@ -841,13 +839,13 @@
841839
"</p>\n",
842840
"\n",
843841
"\n",
844-
"- \ud83d\ude80 **Get your API Key:** [ScrapeGraphAI Dashboard](https://scrapegraphai.com/dashboard) \n",
845-
"- \ud83d\udc19 **GitHub:** [ScrapeGraphAI GitHub](https://github.com/scrapegraphai) \n",
846-
"- \ud83d\udcbc **LinkedIn:** [ScrapeGraphAI LinkedIn](https://www.linkedin.com/company/scrapegraphai/) \n",
847-
"- \ud83d\udc26 **Twitter:** [ScrapeGraphAI Twitter](https://twitter.com/scrapegraphai) \n",
848-
"- \ud83d\udcac **Discord:** [Join our Discord Community](https://discord.gg/uJN7TYcpNa) \n",
842+
"- 🚀 **Get your API Key:** [ScrapeGraphAI Dashboard](https://scrapegraphai.com/dashboard) \n",
843+
"- 🐙 **GitHub:** [ScrapeGraphAI GitHub](https://github.com/scrapegraphai) \n",
844+
"- 💼 **LinkedIn:** [ScrapeGraphAI LinkedIn](https://www.linkedin.com/company/scrapegraphai/) \n",
845+
"- 🐦 **Twitter:** [ScrapeGraphAI Twitter](https://twitter.com/scrapegraphai) \n",
846+
"- 💬 **Discord:** [Join our Discord Community](https://discord.gg/uJN7TYcpNa) \n",
849847
"\n",
850-
"Made with \u2764\ufe0f by the [ScrapeGraphAI](https://scrapegraphai.com) Team \n"
848+
"Made with ❤️ by the [ScrapeGraphAI](https://scrapegraphai.com) Team \n"
851849
]
852850
}
853851
],

0 commit comments

Comments
 (0)