@pencil-agent/nano-pencil 2.0.0-beta.8 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (241) hide show
  1. package/README.md +267 -267
  2. package/dist/build-meta.json +3 -3
  3. package/dist/core/export-html/AGENT.md +11 -11
  4. package/dist/core/export-html/template.css +971 -971
  5. package/dist/core/export-html/template.html +54 -54
  6. package/dist/core/extensions-host/index.d.ts +1 -1
  7. package/dist/core/extensions-host/loader.js +1 -1
  8. package/dist/core/extensions-host/runner.d.ts +1 -0
  9. package/dist/core/extensions-host/runner.js +2 -2
  10. package/dist/core/extensions-host/types.d.ts +17 -22
  11. package/dist/core/lib/ai/src/types.d.ts +12 -2
  12. package/dist/core/persona/persona-manager.js +5 -2
  13. package/dist/core/runtime/agent-session.js +3 -3
  14. package/dist/core/runtime/extension-core-bindings.d.ts +1 -0
  15. package/dist/core/runtime/extension-core-bindings.js +2 -2
  16. package/dist/extensions/builtin/AGENT.md +115 -115
  17. package/dist/extensions/builtin/browser/AGENT.md +17 -17
  18. package/dist/extensions/builtin/browser/agent-workspace/agent_helpers.py +12 -12
  19. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/amazon/product-search.md +198 -198
  20. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/archive-org/scraping.md +341 -341
  21. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/arxiv/scraping.md +311 -311
  22. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/arxiv-bulk/scraping.md +333 -333
  23. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/atlas/overview.md +70 -70
  24. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/booking-com/scraping.md +578 -578
  25. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/capterra/scraping.md +440 -440
  26. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/centilebrain/generate-estimates.md +110 -110
  27. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/coingecko/scraping.md +325 -325
  28. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/coinmarketcap/scraping.md +463 -463
  29. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/coursera/scraping.md +360 -360
  30. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/craigslist/scraping.md +390 -390
  31. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/crossref/scraping.md +568 -568
  32. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/dev-to/scraping.md +323 -323
  33. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/duckduckgo/scraping.md +349 -349
  34. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/ebay/scraping.md +435 -435
  35. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/etsy/scraping.md +506 -506
  36. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/eventbrite/scraping.md +363 -363
  37. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/expedia/automation.md +168 -168
  38. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/facebook/groups.md +236 -236
  39. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/facebook/pages.md +295 -295
  40. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/framer/editor.md +108 -108
  41. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/fred/scraping.md +493 -493
  42. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/g2/scraping.md +580 -580
  43. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/genius/scraping.md +511 -511
  44. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/github/repo-actions.md +65 -65
  45. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/github/scraping.md +184 -184
  46. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/glassdoor/scraping.md +543 -543
  47. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/gmail/compose.md +122 -122
  48. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/goodreads/scraping.md +461 -461
  49. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/gutenberg/scraping.md +383 -383
  50. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/hackernews/scraping.md +243 -243
  51. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/howlongtobeat/scraping.md +473 -473
  52. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/imdb/scraping.md +271 -271
  53. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/itch-io/scraping.md +436 -436
  54. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/job-boards/indeed-glassdoor.md +1021 -1021
  55. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/letterboxd/scraping.md +349 -349
  56. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/linkedin/invitation-manager.md +109 -109
  57. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/loom/folder-enumeration.md +170 -170
  58. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/macrotrends/scraping.md +537 -537
  59. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/medium/article-hydration.md +120 -120
  60. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/medium/scraping.md +414 -414
  61. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/metacritic/scraping.md +477 -477
  62. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/musicbrainz/scraping.md +478 -478
  63. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/nasa/scraping.md +339 -339
  64. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/news-aggregation/multi-source.md +205 -205
  65. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/open-library/scraping.md +472 -472
  66. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/openalex/scraping.md +470 -470
  67. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/openstreetmap/scraping.md +490 -490
  68. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/package-registries/npm-pypi.md +478 -478
  69. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/polymarket/scraping.md +234 -234
  70. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/producthunt/scraping.md +307 -307
  71. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/pubmed/scraping.md +421 -421
  72. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/quora/scraping.md +364 -364
  73. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/rawg/scraping.md +352 -352
  74. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/reddit/scraping.md +124 -124
  75. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/rest-countries/scraping.md +233 -233
  76. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/sec-edgar/scraping.md +361 -361
  77. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/shopify-admin/README.md +36 -36
  78. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/shopify-admin/embedded-apps.md +72 -72
  79. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/shopify-admin/knowledge-base.md +109 -109
  80. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/shopify-admin/polaris-inputs.md +137 -137
  81. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/soundcloud/scraping.md +362 -362
  82. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/spotify/scraping.md +339 -339
  83. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/stackoverflow/scraping.md +435 -435
  84. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/steam/scraping.md +575 -575
  85. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/substack/scraping.md +338 -338
  86. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/thetechgeeks/pricing.md +52 -52
  87. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/tiktok/upload.md +107 -107
  88. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/tradingview/scraping.md +309 -309
  89. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/trello/boards-and-lists.md +88 -88
  90. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/trustpilot/scraping.md +375 -375
  91. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/walmart/scraping.md +444 -444
  92. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/wayback-machine/scraping.md +306 -306
  93. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/weather/scraping.md +398 -398
  94. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/wellfound/scraping.md +596 -596
  95. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/world-bank/scraping.md +356 -356
  96. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/xiaohongshu/scraping.md +84 -84
  97. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/youtube/scraping.md +418 -418
  98. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/zillow/scraping.md +433 -433
  99. package/dist/extensions/builtin/browser/browser.md +73 -73
  100. package/dist/extensions/builtin/browser/install.md +142 -142
  101. package/dist/extensions/builtin/browser/interaction-skills/connection.md +48 -48
  102. package/dist/extensions/builtin/browser/interaction-skills/cookies.md +3 -3
  103. package/dist/extensions/builtin/browser/interaction-skills/cross-origin-iframes.md +3 -3
  104. package/dist/extensions/builtin/browser/interaction-skills/dialogs.md +64 -64
  105. package/dist/extensions/builtin/browser/interaction-skills/downloads.md +3 -3
  106. package/dist/extensions/builtin/browser/interaction-skills/drag-and-drop.md +3 -3
  107. package/dist/extensions/builtin/browser/interaction-skills/dropdowns.md +3 -3
  108. package/dist/extensions/builtin/browser/interaction-skills/iframes.md +3 -3
  109. package/dist/extensions/builtin/browser/interaction-skills/network-requests.md +3 -3
  110. package/dist/extensions/builtin/browser/interaction-skills/print-as-pdf.md +3 -3
  111. package/dist/extensions/builtin/browser/interaction-skills/profile-sync.md +90 -90
  112. package/dist/extensions/builtin/browser/interaction-skills/screenshots.md +17 -17
  113. package/dist/extensions/builtin/browser/interaction-skills/scrolling.md +3 -3
  114. package/dist/extensions/builtin/browser/interaction-skills/shadow-dom.md +3 -3
  115. package/dist/extensions/builtin/browser/interaction-skills/tabs.md +69 -69
  116. package/dist/extensions/builtin/browser/interaction-skills/uploads.md +1 -1
  117. package/dist/extensions/builtin/browser/interaction-skills/viewport.md +3 -3
  118. package/dist/extensions/builtin/browser/src/browser_harness/AGENT.md +15 -15
  119. package/dist/extensions/builtin/browser/src/browser_harness/__init__.py +8 -8
  120. package/dist/extensions/builtin/browser/src/browser_harness/_ipc.py +90 -90
  121. package/dist/extensions/builtin/browser/src/browser_harness/admin.py +722 -722
  122. package/dist/extensions/builtin/browser/src/browser_harness/daemon.py +328 -328
  123. package/dist/extensions/builtin/browser/src/browser_harness/helpers.py +396 -396
  124. package/dist/extensions/builtin/browser/src/browser_harness/run.py +103 -103
  125. package/dist/extensions/builtin/discipline/skills/brainstorming/SKILL.md +33 -33
  126. package/dist/extensions/builtin/discipline/skills/executing-plans/SKILL.md +25 -25
  127. package/dist/extensions/builtin/discipline/skills/finishing-development-branch/SKILL.md +25 -25
  128. package/dist/extensions/builtin/discipline/skills/receiving-code-review/SKILL.md +22 -22
  129. package/dist/extensions/builtin/discipline/skills/requesting-code-review/SKILL.md +31 -31
  130. package/dist/extensions/builtin/discipline/skills/systematic-debugging/SKILL.md +28 -28
  131. package/dist/extensions/builtin/discipline/skills/test-driven-development/SKILL.md +32 -32
  132. package/dist/extensions/builtin/discipline/skills/using-git-worktrees/SKILL.md +25 -25
  133. package/dist/extensions/builtin/discipline/skills/verification-before-completion/SKILL.md +27 -27
  134. package/dist/extensions/builtin/discipline/skills/writing-plans/SKILL.md +26 -26
  135. package/dist/extensions/builtin/goal/README.md +67 -67
  136. package/dist/extensions/builtin/goal/goal-controller.d.ts +39 -10
  137. package/dist/extensions/builtin/goal/goal-controller.js +1 -1
  138. package/dist/extensions/builtin/goal/goal-format.js +1 -1
  139. package/dist/extensions/builtin/goal/goal-prompts.d.ts +2 -0
  140. package/dist/extensions/builtin/goal/goal-prompts.js +5 -4
  141. package/dist/extensions/builtin/goal/goal-store.js +1 -1
  142. package/dist/extensions/builtin/goal/index.d.ts +1 -1
  143. package/dist/extensions/builtin/goal/index.js +10 -7
  144. package/dist/extensions/builtin/grub/README.md +112 -112
  145. package/dist/extensions/builtin/link-world/agent-workspace/README.md +16 -16
  146. package/dist/extensions/builtin/link-world/index.js +6 -6
  147. package/dist/extensions/builtin/link-world/internet-search/internet-search.md +65 -65
  148. package/dist/extensions/builtin/link-world/link-world-agent.md +82 -82
  149. package/dist/extensions/builtin/link-world/linkworld.md +313 -313
  150. package/dist/extensions/builtin/link-world/{network-routing.md → network-routing/network-routing.md} +67 -67
  151. package/dist/extensions/builtin/loop/README.md +92 -92
  152. package/dist/extensions/builtin/mcp/figma-design.md +68 -68
  153. package/dist/extensions/builtin/mcp/mcp-management.md +85 -85
  154. package/dist/extensions/builtin/plan/index.js +1 -1
  155. package/dist/extensions/builtin/recap/AGENT.md +15 -15
  156. package/dist/extensions/builtin/sal/README.md +72 -72
  157. package/dist/extensions/builtin/security-audit/README.md +289 -289
  158. package/dist/extensions/builtin/task/task-store.d.ts +4 -0
  159. package/dist/extensions/builtin/task/task-store.js +1 -1
  160. package/dist/extensions/builtin/team/AGENT.md +112 -112
  161. package/dist/extensions/builtin/team/TESTING.md +299 -299
  162. package/dist/extensions/builtin/token-save/README.md +56 -56
  163. package/dist/extensions/optional/AGENT.md +10 -10
  164. package/dist/index.d.ts +5 -30
  165. package/dist/index.js +1 -1
  166. package/dist/models.d.ts +7 -0
  167. package/dist/models.js +1 -0
  168. package/dist/modes/interactive/components/footer.js +1 -1
  169. package/dist/modes/interactive/components/task-status-panel.d.ts +36 -0
  170. package/dist/modes/interactive/components/task-status-panel.js +1 -0
  171. package/dist/modes/interactive/controllers/stream-render-controller.d.ts +7 -0
  172. package/dist/modes/interactive/controllers/stream-render-controller.js +2 -2
  173. package/dist/modes/interactive/interactive-mode.js +40 -40
  174. package/dist/modes/interactive/state/interactive-state.d.ts +2 -0
  175. package/dist/modes/interactive/state/interactive-state.js +1 -1
  176. package/dist/modes/interactive/theme/dark.json +85 -85
  177. package/dist/modes/interactive/theme/light.json +84 -84
  178. package/dist/modes/interactive/theme/theme-schema.json +335 -335
  179. package/dist/modes/interactive/theme/warm.json +81 -81
  180. package/dist/node_modules/@pencil-agent/ai/dist/cli.js +0 -0
  181. package/dist/node_modules/@pencil-agent/ai/dist/models.generated.js +1 -1
  182. package/dist/node_modules/@pencil-agent/ai/dist/providers/anthropic.js +2 -2
  183. package/dist/node_modules/@pencil-agent/ai/dist/providers/openai-completions.js +5 -5
  184. package/dist/node_modules/@pencil-agent/ai/dist/providers/openai-responses.js +1 -1
  185. package/dist/node_modules/@pencil-agent/ai/dist/stream.js +1 -1
  186. package/dist/packages/protocol/src/commands.d.ts +33 -0
  187. package/dist/packages/protocol/src/flags.d.ts +20 -0
  188. package/dist/packages/protocol/src/hooks.d.ts +17 -0
  189. package/dist/packages/protocol/src/hooks.js +0 -0
  190. package/dist/packages/{extension-sdk → protocol}/src/index.d.ts +7 -4
  191. package/dist/packages/protocol/src/index.js +1 -0
  192. package/dist/packages/{extension-sdk → protocol}/src/lifecycle.d.ts +15 -27
  193. package/dist/packages/protocol/src/lifecycle.js +0 -0
  194. package/dist/packages/{extension-sdk → protocol}/src/tools.d.ts +1 -1
  195. package/dist/packages/protocol/src/tools.js +0 -0
  196. package/dist/public-config.d.ts +12 -0
  197. package/dist/public-config.js +1 -0
  198. package/dist/runtime.d.ts +9 -0
  199. package/dist/runtime.js +1 -0
  200. package/dist/session-compaction.d.ts +7 -0
  201. package/dist/session-compaction.js +1 -0
  202. package/dist/session.d.ts +7 -0
  203. package/dist/session.js +1 -0
  204. package/dist/skills.d.ts +7 -0
  205. package/dist/skills.js +1 -0
  206. package/dist/tools.d.ts +7 -0
  207. package/dist/tools.js +1 -0
  208. package/docs/ACP/345/215/217/350/256/256/351/233/206/346/210/220/345/274/200/345/217/221/346/226/207/346/241/243.md +851 -0
  209. package/docs/SDK-TESTING.md +364 -0
  210. package/docs/codex-goal-command-impl.md +1055 -1055
  211. package/docs/codex-goal-vs-grub.md +500 -500
  212. package/docs/custom-provider.md +27 -27
  213. package/docs/extensions.md +27 -27
  214. package/docs/keybindings.md +27 -27
  215. package/docs/loop /351/207/215/346/236/204/345/256/214/346/210/220/346/200/273/347/273/223.md" +250 -250
  216. package/docs/loop /351/207/215/346/236/204/345/256/214/346/210/220/346/212/245/345/221/212.md" +122 -122
  217. package/docs/loop /351/207/215/346/236/204/346/226/271/346/241/210.md" +1222 -1222
  218. package/docs/loop /351/207/215/346/236/204/346/226/271/346/241/210/345/256/236/347/216/260/346/212/245/345/221/212.md" +158 -158
  219. package/docs/loop /351/207/215/346/236/204/346/226/271/346/241/210/345/257/271/346/257/224/345/210/206/346/236/220.md" +128 -128
  220. package/docs/loop /351/207/215/346/236/204/350/256/241/345/210/222.md" +320 -320
  221. package/docs/loop-usage-examples.md +214 -214
  222. package/docs/mem-core/346/212/200/346/234/257/346/226/207/346/241/243.md +593 -0
  223. package/docs/models.md +27 -27
  224. package/docs/packages.md +27 -27
  225. package/docs/pi-design-philosophy.md +457 -457
  226. package/docs/planmode.md +1987 -1987
  227. package/docs/prompt-templates.md +27 -27
  228. package/docs/providers.md +27 -27
  229. package/docs/sdk.md +27 -27
  230. package/docs/skills.md +27 -27
  231. package/docs/startup-performance-optimization.md +301 -0
  232. package/docs/themes.md +27 -27
  233. package/docs/tui.md +27 -27
  234. package/docs//350/256/244/347/237/245/345/234/260/345/233/276.md +47 -0
  235. package/package.json +190 -162
  236. package/dist/packages/extension-sdk/src/index.js +0 -1
  237. package/docs/cc-agent-design.md +0 -1297
  238. package/docs/cc-tui-design.md +0 -1333
  239. package/docs//345/257/271/346/240/207Claude-Code.md +0 -1775
  240. /package/dist/packages/{extension-sdk/src/lifecycle.js → protocol/src/commands.js} +0 -0
  241. /package/dist/packages/{extension-sdk/src/tools.js → protocol/src/flags.js} +0 -0
@@ -1,383 +1,383 @@
1
- # Project Gutenberg — Scraping & Data Extraction
2
-
3
- `https://www.gutenberg.org` — 78 000+ free public-domain ebooks. Every workflow here is pure `http_get` — no browser needed.
4
-
5
- ## Do this first
6
-
7
- **Use the Gutendex REST API (`gutendex.com`) for all search and discovery. It is one call, returns clean JSON, and requires no auth. Go to gutenberg.org URLs only to fetch actual file content.**
8
-
9
- ```python
10
- import json
11
-
12
- # Search by title/author keyword
13
- data = json.loads(http_get("https://gutendex.com/books/?search=pride+and+prejudice"))
14
- # data['count'] = 6 (total matches)
15
- # data['results'] = list of up to 32 book objects
16
- book = data['results'][0]
17
- # book['id'] = 1342 ← use this ID for all further calls
18
- # book['formats']['text/plain; charset=utf-8'] = direct txt URL
19
-
20
- # Fetch the plain-text content of that book
21
- text = http_get(book['formats']['text/plain; charset=utf-8'])
22
- # Returns 763 083 chars including Project Gutenberg header/footer boilerplate
23
- ```
24
-
25
- For a known book ID, skip search entirely:
26
-
27
- ```python
28
- book = json.loads(http_get("https://gutendex.com/books/1342/"))
29
- ```
30
-
31
- ## Common workflows
32
-
33
- ### Search by keyword and get the first result
34
-
35
- ```python
36
- import json
37
-
38
- data = json.loads(http_get("https://gutendex.com/books/?search=frankenstein"))
39
- if data['results']:
40
- b = data['results'][0]
41
- print(b['id'], b['title'], b['authors'][0]['name'])
42
- # 84 Frankenstein; or, the modern prometheus Shelley, Mary Wollstonecraft
43
- txt_url = b['formats'].get('text/plain; charset=utf-8')
44
- if txt_url:
45
- text = http_get(txt_url)
46
- ```
47
-
48
- ### Get the most downloaded books (popularity ranking)
49
-
50
- ```python
51
- import json
52
-
53
- data = json.loads(http_get("https://gutendex.com/books/?sort=popular"))
54
- for b in data['results'][:10]:
55
- authors = ', '.join(a['name'] for a in b['authors'])
56
- print(f"[{b['id']}] {b['title']} — {authors} ({b['download_count']:,} downloads)")
57
- # [84] Frankenstein — Shelley, Mary Wollstonecraft (178,271)
58
- # [45304] The City of God, Volume I — Augustine, of Hippo, Saint (147,663)
59
- # [2701] Moby Dick; Or, The Whale — Melville, Herman (112,302)
60
- # [1342] Pride and Prejudice — Austen, Jane (107,502)
61
- # [768] Wuthering Heights — Brontë, Emily (72,775)
62
- # [1513] Romeo and Juliet — Shakespeare, William (70,272)
63
- # [11] Alice's Adventures in Wonderland — Carroll, Lewis (65,243)
64
- # [64317] The Great Gatsby — Fitzgerald, F. Scott (60,632)
65
- # [100] Complete Works of Shakespeare — Shakespeare, William (60,527)
66
- # [1260] Jane Eyre: An Autobiography — Brontë, Charlotte (57,602)
67
- ```
68
-
69
- ### Browse by genre / topic
70
-
71
- ```python
72
- import json
73
-
74
- # 'topic' matches both subjects and bookshelves fields
75
- data = json.loads(http_get("https://gutendex.com/books/?topic=science+fiction"))
76
- # data['count'] = 3473 total results, 32 per page
77
-
78
- data = json.loads(http_get("https://gutendex.com/books/?topic=detective+fiction"))
79
- # data['count'] = 111
80
- # data['results'][0]: id=1661 The Adventures of Sherlock Holmes — Doyle, Arthur Conan
81
-
82
- # Filter by language (ISO 639-1 code)
83
- data = json.loads(http_get("https://gutendex.com/books/?languages=fr&topic=roman"))
84
- # data['count'] = 254 French books with 'roman' in topic
85
- ```
86
-
87
- ### Paginate through results
88
-
89
- ```python
90
- import json
91
-
92
- url = "https://gutendex.com/books/?topic=science+fiction"
93
- books = []
94
- while url:
95
- data = json.loads(http_get(url))
96
- books.extend(data['results'])
97
- url = data['next'] # None on last page
98
- # data['previous'] is also populated after page 1
99
- # e.g. data['next'] = "https://gutendex.com/books/?page=3&topic=science+fiction"
100
- # All 3473 sci-fi books loaded across ~109 pages of 32 each
101
- ```
102
-
103
- ### Fetch multiple specific books by ID
104
-
105
- ```python
106
- import json
107
-
108
- data = json.loads(http_get("https://gutendex.com/books/?ids=1342,11,84"))
109
- # Returns exactly those 3 books, count=3
110
- for b in data['results']:
111
- print(b['id'], b['title'])
112
- # 84 Frankenstein; or, the modern prometheus
113
- # 1342 Pride and Prejudice
114
- # 11 Alice's Adventures in Wonderland
115
- ```
116
-
117
- ### Read the plain text of a book (boilerplate stripped)
118
-
119
- ```python
120
- raw = http_get("https://www.gutenberg.org/cache/epub/1342/pg1342.txt")
121
- # 763 083 chars total including PG licence header and footer
122
-
123
- START = "*** START OF THE PROJECT GUTENBERG EBOOK"
124
- END = "*** END OF THE PROJECT GUTENBERG EBOOK"
125
- s = raw.find(START)
126
- e = raw.find(END)
127
- if s != -1:
128
- content = raw[raw.index('\n', s) + 1 : e].strip()
129
- # 743 241 chars of actual novel text
130
- ```
131
-
132
- The cache URL is the most reliable direct path. The `formats` dict in Gutendex also provides a redirect URL that resolves to the same file:
133
-
134
- ```python
135
- # Both of these return identical content (763 083 chars):
136
- http_get("https://www.gutenberg.org/ebooks/1342.txt.utf-8") # redirect
137
- http_get("https://www.gutenberg.org/cache/epub/1342/pg1342.txt") # direct cache
138
- ```
139
-
140
- ### Download formats available per book
141
-
142
- Every book's `formats` dict maps MIME type to URL. All URLs resolve to `/cache/epub/{id}/` files via redirect.
143
-
144
- | MIME type | URL pattern (after redirect) | Typical size |
145
- |---|---|---|
146
- | `text/plain; charset=utf-8` | `pg{id}.txt` | ~750 KB |
147
- | `text/html` | `pg{id}-images.html` | ~850 KB |
148
- | `application/epub+zip` | `pg{id}-images-3.epub` | ~25 MB |
149
- | `application/x-mobipocket-ebook` | `pg{id}-images-kf8.mobi` | ~25 MB |
150
- | `application/rdf+xml` | `{id}.rdf` via gutenberg.org | metadata XML |
151
- | `image/jpeg` | `pg{id}.cover.medium.jpg` | cover image |
152
- | `application/octet-stream` | `pg{id}-h.zip` | HTML+images zip |
153
-
154
- ```python
155
- import json
156
-
157
- b = json.loads(http_get("https://gutendex.com/books/1342/"))
158
- # Grab every downloadable format URL:
159
- for mime, url in b['formats'].items():
160
- print(mime, '->', url)
161
- # text/html -> https://www.gutenberg.org/ebooks/1342.html.images
162
- # application/epub+zip -> https://www.gutenberg.org/ebooks/1342.epub3.images
163
- # application/x-mobipocket-ebook -> https://www.gutenberg.org/ebooks/1342.kf8.images
164
- # application/rdf+xml -> https://www.gutenberg.org/ebooks/1342.rdf
165
- # image/jpeg -> https://www.gutenberg.org/cache/epub/1342/pg1342.cover.medium.jpg
166
- # application/octet-stream -> https://www.gutenberg.org/cache/epub/1342/pg1342-h.zip
167
- # text/plain; charset=utf-8 -> https://www.gutenberg.org/ebooks/1342.txt.utf-8
168
- ```
169
-
170
- ### Fetch RDF/XML metadata for a book
171
-
172
- ```python
173
- import re
174
-
175
- rdf = http_get("https://www.gutenberg.org/cache/epub/1342/pg1342.rdf")
176
- # Also available as: http_get("https://www.gutenberg.org/ebooks/1342.rdf")
177
-
178
- title = re.search(r'<dcterms:title>(.*?)</dcterms:title>', rdf, re.DOTALL)
179
- creator = re.findall(r'<pgterms:name>(.*?)</pgterms:name>', rdf)
180
- birth = re.findall(r'<pgterms:birthdate[^>]*>(\d+)', rdf)
181
- death = re.findall(r'<pgterms:deathdate[^>]*>(\d+)', rdf)
182
- issued = re.search(r'<dcterms:issued[^>]*>(.*?)</dcterms:issued>', rdf)
183
- rights = re.search(r'<dcterms:rights>(.*?)</dcterms:rights>', rdf)
184
- downloads = re.search(r'<pgterms:downloads[^>]*>(\d+)</pgterms:downloads>', rdf)
185
- language = re.search(r'<dcterms:language>.*?<rdf:value>(.*?)</rdf:value>', rdf, re.DOTALL)
186
- subjects = re.findall(r'<dcterms:subject>.*?<rdf:value>(.*?)</rdf:value>.*?</dcterms:subject>', rdf, re.DOTALL)
187
-
188
- print(title.group(1)) # Pride and Prejudice
189
- print(creator) # ['Austen, Jane']
190
- print(birth, death) # ['1775'] ['1817']
191
- print(issued.group(1)) # 1998-06-01
192
- print(rights.group(1)) # Public domain in the USA.
193
- print(int(downloads.group(1))) # 107502
194
- print(subjects[:3]) # ['England -- Fiction', 'Young women -- Fiction', 'Love stories']
195
- ```
196
-
197
- Note: `<dcterms:language>` value is a subject string, not a language code. For language codes use the Gutendex `languages` field instead.
198
-
199
- ### Search the HTML catalog (25 results per page)
200
-
201
- Use this only when you need to leverage Gutenberg's own search index (author:, title:, subject: prefix syntax).
202
-
203
- ```python
204
- import re, json
205
-
206
- html = http_get(
207
- "https://www.gutenberg.org/ebooks/search/"
208
- "?query=shakespeare&sort_order=downloads"
209
- )
210
- # sort_order options: downloads, title, release_date, last_update, random
211
-
212
- entries = re.findall(r'<li class="booklink">(.*?)</li>', html, re.DOTALL)
213
- books = []
214
- for e in entries:
215
- book_id = re.search(r'/ebooks/(\d+)', e)
216
- title = re.search(r'<span class="title">(.*?)</span>', e)
217
- author = re.search(r'<span class="subtitle">(.*?)</span>', e)
218
- downloads = re.search(r'<span class="extra">([^<]+)</span>', e)
219
- books.append({
220
- 'id': int(book_id.group(1)) if book_id else None,
221
- 'title': title.group(1) if title else '',
222
- 'author': author.group(1) if author else '',
223
- 'downloads': downloads.group(1).strip() if downloads else '',
224
- })
225
-
226
- # books[0] = {'id': 1513, 'title': 'Romeo and Juliet',
227
- # 'author': 'William Shakespeare', 'downloads': '74316 downloads'}
228
-
229
- # Paginate with start_index (25 per page)
230
- html_p2 = http_get(
231
- "https://www.gutenberg.org/ebooks/search/"
232
- "?query=shakespeare&sort_order=downloads&start_index=26"
233
- )
234
- ```
235
-
236
- ### Browse a bookshelf (curated genre list)
237
-
238
- ```python
239
- import re
240
-
241
- # Bookshelf 68 = Science Fiction
242
- html = http_get("https://www.gutenberg.org/ebooks/bookshelf/68")
243
- titles = re.findall(r'<span class="title">(.*?)</span>', html)
244
- # ['Twenty Thousand Leagues under the Sea', 'The War of the Worlds',
245
- # 'The Time Machine', 'Thuvia, Maid of Mars', ...]
246
- ```
247
-
248
- ### OPDS catalog (machine-readable Atom feed)
249
-
250
- ```python
251
- import re
252
-
253
- feed = http_get("https://www.gutenberg.org/ebooks/search.opds/?query=dracula")
254
- # Returns Atom XML, 7 entries per page (including 1 metadata entry)
255
- entries = re.findall(r'<entry>(.*?)</entry>', feed, re.DOTALL)
256
- for e in entries:
257
- title = re.search(r'<title>(.*?)</title>', e)
258
- entry_id = re.search(r'<id>(.*?)</id>', e)
259
- if title and entry_id and 'opds' in entry_id.group(1):
260
- book_id = re.search(r'/ebooks/(\d+)\.opds', entry_id.group(1))
261
- print(book_id.group(1), title.group(1))
262
- # 345 Dracula
263
- ```
264
-
265
- ## Gutendex API — full response schema
266
-
267
- Validated against a real call to `GET https://gutendex.com/books/1342/`:
268
-
269
- ```json
270
- {
271
- "id": 1342,
272
- "title": "Pride and Prejudice",
273
- "authors": [
274
- {"name": "Austen, Jane", "birth_year": 1775, "death_year": 1817}
275
- ],
276
- "summaries": ["...automatically generated summary..."],
277
- "editors": [],
278
- "translators": [],
279
- "subjects": [
280
- "Courtship -- Fiction",
281
- "Domestic fiction",
282
- "England -- Fiction",
283
- "Love stories",
284
- "Sisters -- Fiction",
285
- "Women -- England -- Fiction",
286
- "Young women -- Fiction"
287
- ],
288
- "bookshelves": [
289
- "Best Books Ever Listings",
290
- "Category: British Literature",
291
- "Category: Classics of Literature",
292
- "Category: Novels",
293
- "Category: Romance",
294
- "Harvard Classics"
295
- ],
296
- "languages": ["en"],
297
- "copyright": false,
298
- "media_type": "Text",
299
- "formats": {
300
- "text/html": "https://www.gutenberg.org/ebooks/1342.html.images",
301
- "application/epub+zip": "https://www.gutenberg.org/ebooks/1342.epub3.images",
302
- "application/x-mobipocket-ebook": "https://www.gutenberg.org/ebooks/1342.kf8.images",
303
- "application/rdf+xml": "https://www.gutenberg.org/ebooks/1342.rdf",
304
- "image/jpeg": "https://www.gutenberg.org/cache/epub/1342/pg1342.cover.medium.jpg",
305
- "application/octet-stream": "https://www.gutenberg.org/cache/epub/1342/pg1342-h.zip",
306
- "text/plain; charset=utf-8": "https://www.gutenberg.org/ebooks/1342.txt.utf-8"
307
- },
308
- "download_count": 107502
309
- }
310
- ```
311
-
312
- List response wrapper (from `GET /books/`):
313
-
314
- ```json
315
- {
316
- "count": 6,
317
- "next": null,
318
- "previous": null,
319
- "results": [...]
320
- }
321
- ```
322
-
323
- `count` is the total across all pages. `next` / `previous` are fully-formed URLs ready to pass to `http_get`, or `null` when absent.
324
-
325
- ## Gutendex query parameters
326
-
327
- All parameters combine freely.
328
-
329
- | Parameter | Example | Notes |
330
- |---|---|---|
331
- | `search` | `search=moby+dick` | Matches title and author |
332
- | `ids` | `ids=1342,11,84` | Comma-separated; returns only those books |
333
- | `languages` | `languages=fr` | ISO 639-1 code; comma-separated for multiple |
334
- | `topic` | `topic=science+fiction` | Matches subjects + bookshelves |
335
- | `author_year_start` | `author_year_start=1800` | Author born on/after year |
336
- | `author_year_end` | `author_year_end=1850` | Author born on/before year |
337
- | `copyright` | `copyright=false` | `false`=public domain, `true`=copyrighted |
338
- | `sort` | `sort=popular` | `popular` (default), `ascending`, `descending` |
339
- | `page` | `page=2` | 1-based; 32 results per page (not configurable) |
340
-
341
- `page_size` is not supported — always 32 results per page regardless.
342
-
343
- ## Finding book IDs
344
-
345
- Three ways, in order of preference:
346
-
347
- 1. **Gutendex search** — returns `id` directly in JSON.
348
- 2. **Gutenberg HTML catalog** — `book_id = re.search(r'/ebooks/(\d+)', entry)`. IDs in the URL.
349
- 3. **URL pattern** — `https://www.gutenberg.org/ebooks/{id}` — if you already know the ID from any source.
350
-
351
- Notable IDs validated in tests: `84` (Frankenstein), `1342` (Pride and Prejudice), `11` (Alice in Wonderland), `2701` (Moby Dick), `64317` (The Great Gatsby), `1513` (Romeo and Juliet), `100` (Complete Works of Shakespeare), `1661` (Adventures of Sherlock Holmes), `345` (Dracula).
352
-
353
- ## Rate limits
354
-
355
- Gutendex (`gutendex.com`) returns no `X-RateLimit-*` headers. Server is Apache/2.4.58 on Ubuntu. Rapid sequential calls can trigger connection resets — observed a timeout on the second call in a tight loop. Add a small delay between calls when paginating:
356
-
357
- ```python
358
- import time, json
359
-
360
- url = "https://gutendex.com/books/?sort=popular"
361
- while url:
362
- data = json.loads(http_get(url))
363
- # ... process data['results'] ...
364
- url = data['next']
365
- if url:
366
- time.sleep(0.5) # be respectful — no published rate limit but timeouts observed
367
- ```
368
-
369
- For gutenberg.org file downloads (txt, epub, etc.) there is no documented rate limit but Gutenberg asks not to use automated bulk downloading; use their [offline catalogs](https://www.gutenberg.org/ebooks/offline_catalogs.html) for bulk access.
370
-
371
- ## Gotchas
372
-
373
- - **`.opf` 404**: `https://www.gutenberg.org/cache/epub/1342/pg1342.opf` returns 404. Use `.rdf` instead — same path prefix, same data in RDF/XML.
374
- - **`formats` URLs redirect**: URLs like `https://www.gutenberg.org/ebooks/1342.txt.utf-8` are redirect endpoints that resolve to `/cache/epub/1342/pg1342.txt`. Either form works with `http_get` (urllib follows redirects automatically), but the `/cache/epub/` direct URL avoids an extra round trip.
375
- - **Two text files**: `/files/1342/1342-0.txt` (older Project Gutenberg edition, 729 KB) and `/cache/epub/1342/pg1342.txt` (modern edition, 763 KB) contain different versions of the same book. The Gutendex `formats` entry always points to the cache/modern version.
376
- - **Boilerplate**: Every `.txt` file opens with a PG licence header and closes with a footer. Strip with `START`/`END` markers (see "Read the plain text" section above).
377
- - **`summaries` field is AI-generated**: The `summaries` array in Gutendex responses contains automatically generated summaries, not the author's original blurb.
378
- - **`copyright: false`** means public domain in the USA. Non-US copyright status is not tracked.
379
- - **`page_size` ignored**: Passing `?page_size=5` to Gutendex has no effect — always returns 32 results.
380
- - **Gutendex `sort=ascending/descending`** sorts by ID (oldest/newest book in the catalog), not by title or author name.
381
- - **Catalog search `author:` prefix**: `?query=author:dickens` searches within author names but Gutenberg's relevance ranking is fuzzy and can return unexpected results. For precise author lookup use Gutendex `?search=charles+dickens`.
382
- - **OPDS pagination**: Only 7 entries per page (1 metadata + 6 books). Slow for bulk extraction — use Gutendex instead.
383
- - **HTML catalog `start_index`**: Pagination is 25 per page. Next page = `start_index=26`, then `51`, `76`, etc. The value appears in the rendered HTML (`re.findall(r'start_index=(\d+)', html)` returns the next page's value).
1
+ # Project Gutenberg — Scraping & Data Extraction
2
+
3
+ `https://www.gutenberg.org` — 78 000+ free public-domain ebooks. Every workflow here is pure `http_get` — no browser needed.
4
+
5
+ ## Do this first
6
+
7
+ **Use the Gutendex REST API (`gutendex.com`) for all search and discovery. It is one call, returns clean JSON, and requires no auth. Go to gutenberg.org URLs only to fetch actual file content.**
8
+
9
+ ```python
10
+ import json
11
+
12
+ # Search by title/author keyword
13
+ data = json.loads(http_get("https://gutendex.com/books/?search=pride+and+prejudice"))
14
+ # data['count'] = 6 (total matches)
15
+ # data['results'] = list of up to 32 book objects
16
+ book = data['results'][0]
17
+ # book['id'] = 1342 ← use this ID for all further calls
18
+ # book['formats']['text/plain; charset=utf-8'] = direct txt URL
19
+
20
+ # Fetch the plain-text content of that book
21
+ text = http_get(book['formats']['text/plain; charset=utf-8'])
22
+ # Returns 763 083 chars including Project Gutenberg header/footer boilerplate
23
+ ```
24
+
25
+ For a known book ID, skip search entirely:
26
+
27
+ ```python
28
+ book = json.loads(http_get("https://gutendex.com/books/1342/"))
29
+ ```
30
+
31
+ ## Common workflows
32
+
33
+ ### Search by keyword and get the first result
34
+
35
+ ```python
36
+ import json
37
+
38
+ data = json.loads(http_get("https://gutendex.com/books/?search=frankenstein"))
39
+ if data['results']:
40
+ b = data['results'][0]
41
+ print(b['id'], b['title'], b['authors'][0]['name'])
42
+ # 84 Frankenstein; or, the modern prometheus Shelley, Mary Wollstonecraft
43
+ txt_url = b['formats'].get('text/plain; charset=utf-8')
44
+ if txt_url:
45
+ text = http_get(txt_url)
46
+ ```
47
+
48
+ ### Get the most downloaded books (popularity ranking)
49
+
50
+ ```python
51
+ import json
52
+
53
+ data = json.loads(http_get("https://gutendex.com/books/?sort=popular"))
54
+ for b in data['results'][:10]:
55
+ authors = ', '.join(a['name'] for a in b['authors'])
56
+ print(f"[{b['id']}] {b['title']} — {authors} ({b['download_count']:,} downloads)")
57
+ # [84] Frankenstein — Shelley, Mary Wollstonecraft (178,271)
58
+ # [45304] The City of God, Volume I — Augustine, of Hippo, Saint (147,663)
59
+ # [2701] Moby Dick; Or, The Whale — Melville, Herman (112,302)
60
+ # [1342] Pride and Prejudice — Austen, Jane (107,502)
61
+ # [768] Wuthering Heights — Brontë, Emily (72,775)
62
+ # [1513] Romeo and Juliet — Shakespeare, William (70,272)
63
+ # [11] Alice's Adventures in Wonderland — Carroll, Lewis (65,243)
64
+ # [64317] The Great Gatsby — Fitzgerald, F. Scott (60,632)
65
+ # [100] Complete Works of Shakespeare — Shakespeare, William (60,527)
66
+ # [1260] Jane Eyre: An Autobiography — Brontë, Charlotte (57,602)
67
+ ```
68
+
69
+ ### Browse by genre / topic
70
+
71
+ ```python
72
+ import json
73
+
74
+ # 'topic' matches both subjects and bookshelves fields
75
+ data = json.loads(http_get("https://gutendex.com/books/?topic=science+fiction"))
76
+ # data['count'] = 3473 total results, 32 per page
77
+
78
+ data = json.loads(http_get("https://gutendex.com/books/?topic=detective+fiction"))
79
+ # data['count'] = 111
80
+ # data['results'][0]: id=1661 The Adventures of Sherlock Holmes — Doyle, Arthur Conan
81
+
82
+ # Filter by language (ISO 639-1 code)
83
+ data = json.loads(http_get("https://gutendex.com/books/?languages=fr&topic=roman"))
84
+ # data['count'] = 254 French books with 'roman' in topic
85
+ ```
86
+
87
+ ### Paginate through results
88
+
89
+ ```python
90
+ import json
91
+
92
+ url = "https://gutendex.com/books/?topic=science+fiction"
93
+ books = []
94
+ while url:
95
+ data = json.loads(http_get(url))
96
+ books.extend(data['results'])
97
+ url = data['next'] # None on last page
98
+ # data['previous'] is also populated after page 1
99
+ # e.g. data['next'] = "https://gutendex.com/books/?page=3&topic=science+fiction"
100
+ # All 3473 sci-fi books loaded across ~109 pages of 32 each
101
+ ```
102
+
103
+ ### Fetch multiple specific books by ID
104
+
105
+ ```python
106
+ import json
107
+
108
+ data = json.loads(http_get("https://gutendex.com/books/?ids=1342,11,84"))
109
+ # Returns exactly those 3 books, count=3
110
+ for b in data['results']:
111
+ print(b['id'], b['title'])
112
+ # 84 Frankenstein; or, the modern prometheus
113
+ # 1342 Pride and Prejudice
114
+ # 11 Alice's Adventures in Wonderland
115
+ ```
116
+
117
+ ### Read the plain text of a book (boilerplate stripped)
118
+
119
+ ```python
120
+ raw = http_get("https://www.gutenberg.org/cache/epub/1342/pg1342.txt")
121
+ # 763 083 chars total including PG licence header and footer
122
+
123
+ START = "*** START OF THE PROJECT GUTENBERG EBOOK"
124
+ END = "*** END OF THE PROJECT GUTENBERG EBOOK"
125
+ s = raw.find(START)
126
+ e = raw.find(END)
127
+ if s != -1:
128
+ content = raw[raw.index('\n', s) + 1 : e].strip()
129
+ # 743 241 chars of actual novel text
130
+ ```
131
+
132
+ The cache URL is the most reliable direct path. The `formats` dict in Gutendex also provides a redirect URL that resolves to the same file:
133
+
134
+ ```python
135
+ # Both of these return identical content (763 083 chars):
136
+ http_get("https://www.gutenberg.org/ebooks/1342.txt.utf-8") # redirect
137
+ http_get("https://www.gutenberg.org/cache/epub/1342/pg1342.txt") # direct cache
138
+ ```
139
+
140
+ ### Download formats available per book
141
+
142
+ Every book's `formats` dict maps MIME type to URL. All URLs resolve to `/cache/epub/{id}/` files via redirect.
143
+
144
+ | MIME type | URL pattern (after redirect) | Typical size |
145
+ |---|---|---|
146
+ | `text/plain; charset=utf-8` | `pg{id}.txt` | ~750 KB |
147
+ | `text/html` | `pg{id}-images.html` | ~850 KB |
148
+ | `application/epub+zip` | `pg{id}-images-3.epub` | ~25 MB |
149
+ | `application/x-mobipocket-ebook` | `pg{id}-images-kf8.mobi` | ~25 MB |
150
+ | `application/rdf+xml` | `{id}.rdf` via gutenberg.org | metadata XML |
151
+ | `image/jpeg` | `pg{id}.cover.medium.jpg` | cover image |
152
+ | `application/octet-stream` | `pg{id}-h.zip` | HTML+images zip |
153
+
154
+ ```python
155
+ import json
156
+
157
+ b = json.loads(http_get("https://gutendex.com/books/1342/"))
158
+ # Grab every downloadable format URL:
159
+ for mime, url in b['formats'].items():
160
+ print(mime, '->', url)
161
+ # text/html -> https://www.gutenberg.org/ebooks/1342.html.images
162
+ # application/epub+zip -> https://www.gutenberg.org/ebooks/1342.epub3.images
163
+ # application/x-mobipocket-ebook -> https://www.gutenberg.org/ebooks/1342.kf8.images
164
+ # application/rdf+xml -> https://www.gutenberg.org/ebooks/1342.rdf
165
+ # image/jpeg -> https://www.gutenberg.org/cache/epub/1342/pg1342.cover.medium.jpg
166
+ # application/octet-stream -> https://www.gutenberg.org/cache/epub/1342/pg1342-h.zip
167
+ # text/plain; charset=utf-8 -> https://www.gutenberg.org/ebooks/1342.txt.utf-8
168
+ ```
169
+
170
+ ### Fetch RDF/XML metadata for a book
171
+
172
+ ```python
173
+ import re
174
+
175
+ rdf = http_get("https://www.gutenberg.org/cache/epub/1342/pg1342.rdf")
176
+ # Also available as: http_get("https://www.gutenberg.org/ebooks/1342.rdf")
177
+
178
+ title = re.search(r'<dcterms:title>(.*?)</dcterms:title>', rdf, re.DOTALL)
179
+ creator = re.findall(r'<pgterms:name>(.*?)</pgterms:name>', rdf)
180
+ birth = re.findall(r'<pgterms:birthdate[^>]*>(\d+)', rdf)
181
+ death = re.findall(r'<pgterms:deathdate[^>]*>(\d+)', rdf)
182
+ issued = re.search(r'<dcterms:issued[^>]*>(.*?)</dcterms:issued>', rdf)
183
+ rights = re.search(r'<dcterms:rights>(.*?)</dcterms:rights>', rdf)
184
+ downloads = re.search(r'<pgterms:downloads[^>]*>(\d+)</pgterms:downloads>', rdf)
185
+ language = re.search(r'<dcterms:language>.*?<rdf:value>(.*?)</rdf:value>', rdf, re.DOTALL)
186
+ subjects = re.findall(r'<dcterms:subject>.*?<rdf:value>(.*?)</rdf:value>.*?</dcterms:subject>', rdf, re.DOTALL)
187
+
188
+ print(title.group(1)) # Pride and Prejudice
189
+ print(creator) # ['Austen, Jane']
190
+ print(birth, death) # ['1775'] ['1817']
191
+ print(issued.group(1)) # 1998-06-01
192
+ print(rights.group(1)) # Public domain in the USA.
193
+ print(int(downloads.group(1))) # 107502
194
+ print(subjects[:3]) # ['England -- Fiction', 'Young women -- Fiction', 'Love stories']
195
+ ```
196
+
197
+ Note: `<dcterms:language>` value is a subject string, not a language code. For language codes use the Gutendex `languages` field instead.
198
+
199
+ ### Search the HTML catalog (25 results per page)
200
+
201
+ Use this only when you need to leverage Gutenberg's own search index (author:, title:, subject: prefix syntax).
202
+
203
+ ```python
204
+ import re, json
205
+
206
+ html = http_get(
207
+ "https://www.gutenberg.org/ebooks/search/"
208
+ "?query=shakespeare&sort_order=downloads"
209
+ )
210
+ # sort_order options: downloads, title, release_date, last_update, random
211
+
212
+ entries = re.findall(r'<li class="booklink">(.*?)</li>', html, re.DOTALL)
213
+ books = []
214
+ for e in entries:
215
+ book_id = re.search(r'/ebooks/(\d+)', e)
216
+ title = re.search(r'<span class="title">(.*?)</span>', e)
217
+ author = re.search(r'<span class="subtitle">(.*?)</span>', e)
218
+ downloads = re.search(r'<span class="extra">([^<]+)</span>', e)
219
+ books.append({
220
+ 'id': int(book_id.group(1)) if book_id else None,
221
+ 'title': title.group(1) if title else '',
222
+ 'author': author.group(1) if author else '',
223
+ 'downloads': downloads.group(1).strip() if downloads else '',
224
+ })
225
+
226
+ # books[0] = {'id': 1513, 'title': 'Romeo and Juliet',
227
+ # 'author': 'William Shakespeare', 'downloads': '74316 downloads'}
228
+
229
+ # Paginate with start_index (25 per page)
230
+ html_p2 = http_get(
231
+ "https://www.gutenberg.org/ebooks/search/"
232
+ "?query=shakespeare&sort_order=downloads&start_index=26"
233
+ )
234
+ ```
235
+
236
+ ### Browse a bookshelf (curated genre list)
237
+
238
+ ```python
239
+ import re
240
+
241
+ # Bookshelf 68 = Science Fiction
242
+ html = http_get("https://www.gutenberg.org/ebooks/bookshelf/68")
243
+ titles = re.findall(r'<span class="title">(.*?)</span>', html)
244
+ # ['Twenty Thousand Leagues under the Sea', 'The War of the Worlds',
245
+ # 'The Time Machine', 'Thuvia, Maid of Mars', ...]
246
+ ```
247
+
248
+ ### OPDS catalog (machine-readable Atom feed)
249
+
250
+ ```python
251
+ import re
252
+
253
+ feed = http_get("https://www.gutenberg.org/ebooks/search.opds/?query=dracula")
254
+ # Returns Atom XML, 7 entries per page (including 1 metadata entry)
255
+ entries = re.findall(r'<entry>(.*?)</entry>', feed, re.DOTALL)
256
+ for e in entries:
257
+ title = re.search(r'<title>(.*?)</title>', e)
258
+ entry_id = re.search(r'<id>(.*?)</id>', e)
259
+ if title and entry_id and 'opds' in entry_id.group(1):
260
+ book_id = re.search(r'/ebooks/(\d+)\.opds', entry_id.group(1))
261
+ print(book_id.group(1), title.group(1))
262
+ # 345 Dracula
263
+ ```
264
+
265
+ ## Gutendex API — full response schema
266
+
267
+ Validated against a real call to `GET https://gutendex.com/books/1342/`:
268
+
269
+ ```json
270
+ {
271
+ "id": 1342,
272
+ "title": "Pride and Prejudice",
273
+ "authors": [
274
+ {"name": "Austen, Jane", "birth_year": 1775, "death_year": 1817}
275
+ ],
276
+ "summaries": ["...automatically generated summary..."],
277
+ "editors": [],
278
+ "translators": [],
279
+ "subjects": [
280
+ "Courtship -- Fiction",
281
+ "Domestic fiction",
282
+ "England -- Fiction",
283
+ "Love stories",
284
+ "Sisters -- Fiction",
285
+ "Women -- England -- Fiction",
286
+ "Young women -- Fiction"
287
+ ],
288
+ "bookshelves": [
289
+ "Best Books Ever Listings",
290
+ "Category: British Literature",
291
+ "Category: Classics of Literature",
292
+ "Category: Novels",
293
+ "Category: Romance",
294
+ "Harvard Classics"
295
+ ],
296
+ "languages": ["en"],
297
+ "copyright": false,
298
+ "media_type": "Text",
299
+ "formats": {
300
+ "text/html": "https://www.gutenberg.org/ebooks/1342.html.images",
301
+ "application/epub+zip": "https://www.gutenberg.org/ebooks/1342.epub3.images",
302
+ "application/x-mobipocket-ebook": "https://www.gutenberg.org/ebooks/1342.kf8.images",
303
+ "application/rdf+xml": "https://www.gutenberg.org/ebooks/1342.rdf",
304
+ "image/jpeg": "https://www.gutenberg.org/cache/epub/1342/pg1342.cover.medium.jpg",
305
+ "application/octet-stream": "https://www.gutenberg.org/cache/epub/1342/pg1342-h.zip",
306
+ "text/plain; charset=utf-8": "https://www.gutenberg.org/ebooks/1342.txt.utf-8"
307
+ },
308
+ "download_count": 107502
309
+ }
310
+ ```
311
+
312
+ List response wrapper (from `GET /books/`):
313
+
314
+ ```json
315
+ {
316
+ "count": 6,
317
+ "next": null,
318
+ "previous": null,
319
+ "results": [...]
320
+ }
321
+ ```
322
+
323
+ `count` is the total across all pages. `next` / `previous` are fully-formed URLs ready to pass to `http_get`, or `null` when absent.
324
+
325
+ ## Gutendex query parameters
326
+
327
+ All parameters combine freely.
328
+
329
+ | Parameter | Example | Notes |
330
+ |---|---|---|
331
+ | `search` | `search=moby+dick` | Matches title and author |
332
+ | `ids` | `ids=1342,11,84` | Comma-separated; returns only those books |
333
+ | `languages` | `languages=fr` | ISO 639-1 code; comma-separated for multiple |
334
+ | `topic` | `topic=science+fiction` | Matches subjects + bookshelves |
335
+ | `author_year_start` | `author_year_start=1800` | Author born on/after year |
336
+ | `author_year_end` | `author_year_end=1850` | Author born on/before year |
337
+ | `copyright` | `copyright=false` | `false`=public domain, `true`=copyrighted |
338
+ | `sort` | `sort=popular` | `popular` (default), `ascending`, `descending` |
339
+ | `page` | `page=2` | 1-based; 32 results per page (not configurable) |
340
+
341
+ `page_size` is not supported — always 32 results per page regardless.
342
+
343
+ ## Finding book IDs
344
+
345
+ Three ways, in order of preference:
346
+
347
+ 1. **Gutendex search** — returns `id` directly in JSON.
348
+ 2. **Gutenberg HTML catalog** — `book_id = re.search(r'/ebooks/(\d+)', entry)`. IDs in the URL.
349
+ 3. **URL pattern** — `https://www.gutenberg.org/ebooks/{id}` — if you already know the ID from any source.
350
+
351
+ Notable IDs validated in tests: `84` (Frankenstein), `1342` (Pride and Prejudice), `11` (Alice in Wonderland), `2701` (Moby Dick), `64317` (The Great Gatsby), `1513` (Romeo and Juliet), `100` (Complete Works of Shakespeare), `1661` (Adventures of Sherlock Holmes), `345` (Dracula).
352
+
353
+ ## Rate limits
354
+
355
+ Gutendex (`gutendex.com`) returns no `X-RateLimit-*` headers. Server is Apache/2.4.58 on Ubuntu. Rapid sequential calls can trigger connection resets — observed a timeout on the second call in a tight loop. Add a small delay between calls when paginating:
356
+
357
+ ```python
358
+ import time, json
359
+
360
+ url = "https://gutendex.com/books/?sort=popular"
361
+ while url:
362
+ data = json.loads(http_get(url))
363
+ # ... process data['results'] ...
364
+ url = data['next']
365
+ if url:
366
+ time.sleep(0.5) # be respectful — no published rate limit but timeouts observed
367
+ ```
368
+
369
+ For gutenberg.org file downloads (txt, epub, etc.) there is no documented rate limit but Gutenberg asks not to use automated bulk downloading; use their [offline catalogs](https://www.gutenberg.org/ebooks/offline_catalogs.html) for bulk access.
370
+
371
+ ## Gotchas
372
+
373
+ - **`.opf` 404**: `https://www.gutenberg.org/cache/epub/1342/pg1342.opf` returns 404. Use `.rdf` instead — same path prefix, same data in RDF/XML.
374
+ - **`formats` URLs redirect**: URLs like `https://www.gutenberg.org/ebooks/1342.txt.utf-8` are redirect endpoints that resolve to `/cache/epub/1342/pg1342.txt`. Either form works with `http_get` (urllib follows redirects automatically), but the `/cache/epub/` direct URL avoids an extra round trip.
375
+ - **Two text files**: `/files/1342/1342-0.txt` (older Project Gutenberg edition, 729 KB) and `/cache/epub/1342/pg1342.txt` (modern edition, 763 KB) contain different versions of the same book. The Gutendex `formats` entry always points to the cache/modern version.
376
+ - **Boilerplate**: Every `.txt` file opens with a PG licence header and closes with a footer. Strip with `START`/`END` markers (see "Read the plain text" section above).
377
+ - **`summaries` field is AI-generated**: The `summaries` array in Gutendex responses contains automatically generated summaries, not the author's original blurb.
378
+ - **`copyright: false`** means public domain in the USA. Non-US copyright status is not tracked.
379
+ - **`page_size` ignored**: Passing `?page_size=5` to Gutendex has no effect — always returns 32 results.
380
+ - **Gutendex `sort=ascending/descending`** sorts by ID (oldest/newest book in the catalog), not by title or author name.
381
+ - **Catalog search `author:` prefix**: `?query=author:dickens` searches within author names but Gutenberg's relevance ranking is fuzzy and can return unexpected results. For precise author lookup use Gutendex `?search=charles+dickens`.
382
+ - **OPDS pagination**: Only 7 entries per page (1 metadata + 6 books). Slow for bulk extraction — use Gutendex instead.
383
+ - **HTML catalog `start_index`**: Pagination is 25 per page. Next page = `start_index=26`, then `51`, `76`, etc. The value appears in the rendered HTML (`re.findall(r'start_index=(\d+)', html)` returns the next page's value).