proseview 0.4.2__tar.gz → 0.5.0__tar.gz

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 (327) hide show
  1. proseview-0.5.0/PKG-INFO +428 -0
  2. proseview-0.5.0/README.md +384 -0
  3. {proseview-0.4.2 → proseview-0.5.0}/proseview/__init__.py +1 -1
  4. proseview-0.5.0/proseview/agy_acp_client.py +1294 -0
  5. proseview-0.5.0/proseview/beatmap.py +1081 -0
  6. {proseview-0.4.2 → proseview-0.5.0}/proseview/book.py +3 -0
  7. {proseview-0.4.2 → proseview-0.5.0}/proseview/book_styles/__init__.py +24 -5
  8. {proseview-0.4.2 → proseview-0.5.0}/proseview/book_styles/classic/epub.css +27 -0
  9. {proseview-0.4.2 → proseview-0.5.0}/proseview/book_styles/classic/pdf.typ +19 -1
  10. {proseview-0.4.2 → proseview-0.5.0}/proseview/book_styles/manuscript/pdf.typ +15 -1
  11. {proseview-0.4.2 → proseview-0.5.0}/proseview/book_styles/manuscript/style.yaml +2 -2
  12. proseview-0.5.0/proseview/browser.py +152 -0
  13. proseview-0.5.0/proseview/builtin_skills.py +85 -0
  14. proseview-0.5.0/proseview/callouts.py +235 -0
  15. proseview-0.5.0/proseview/citations.py +338 -0
  16. {proseview-0.4.2 → proseview-0.5.0}/proseview/claude_agent_client.py +276 -22
  17. {proseview-0.4.2 → proseview-0.5.0}/proseview/cli.py +56 -12
  18. {proseview-0.4.2 → proseview-0.5.0}/proseview/codex_app_server.py +5 -0
  19. {proseview-0.4.2 → proseview-0.5.0}/proseview/config.py +420 -15
  20. proseview-0.5.0/proseview/craft.py +187 -0
  21. {proseview-0.4.2 → proseview-0.5.0}/proseview/discuss.py +3219 -179
  22. proseview-0.5.0/proseview/docx.py +1326 -0
  23. proseview-0.5.0/proseview/docx_check.py +138 -0
  24. {proseview-0.4.2 → proseview-0.5.0}/proseview/epub.py +7 -1
  25. {proseview-0.4.2 → proseview-0.5.0}/proseview/export.py +40 -11
  26. {proseview-0.4.2 → proseview-0.5.0}/proseview/export_dashboard.py +211 -38
  27. {proseview-0.4.2 → proseview-0.5.0}/proseview/export_demo.py +11 -3
  28. {proseview-0.4.2 → proseview-0.5.0}/proseview/generator.py +522 -188
  29. {proseview-0.4.2 → proseview-0.5.0}/proseview/goals.py +62 -24
  30. proseview-0.5.0/proseview/group.py +337 -0
  31. proseview-0.5.0/proseview/group_context.py +112 -0
  32. proseview-0.5.0/proseview/group_fork.py +500 -0
  33. proseview-0.5.0/proseview/group_runtime.py +768 -0
  34. proseview-0.5.0/proseview/highlights.py +674 -0
  35. proseview-0.5.0/proseview/history.py +816 -0
  36. {proseview-0.4.2 → proseview-0.5.0}/proseview/hunks.py +39 -0
  37. proseview-0.5.0/proseview/ledger.py +219 -0
  38. {proseview-0.4.2 → proseview-0.5.0}/proseview/lexical.py +218 -11
  39. {proseview-0.4.2 → proseview-0.5.0}/proseview/obsidian.py +6 -15
  40. {proseview-0.4.2 → proseview-0.5.0}/proseview/pdf.py +69 -9
  41. proseview-0.5.0/proseview/privacy.py +150 -0
  42. proseview-0.5.0/proseview/quote_compare.py +146 -0
  43. {proseview-0.4.2 → proseview-0.5.0}/proseview/repo.py +34 -0
  44. proseview-0.5.0/proseview/reviews.py +151 -0
  45. {proseview-0.4.2 → proseview-0.5.0}/proseview/scenes.py +69 -18
  46. {proseview-0.4.2 → proseview-0.5.0}/proseview/server.py +788 -59
  47. proseview-0.5.0/proseview/skills/builtin_manifest.json +412 -0
  48. proseview-0.5.0/proseview/skills/canon_refactor/SKILL.md +24 -0
  49. proseview-0.5.0/proseview/skills/comedy_review/SKILL.md +20 -0
  50. proseview-0.5.0/proseview/skills/craft_coyne/SKILL.md +11 -0
  51. proseview-0.5.0/proseview/skills/craft_coyne/agents/openai.yaml +2 -0
  52. proseview-0.5.0/proseview/skills/craft_cron/SKILL.md +11 -0
  53. proseview-0.5.0/proseview/skills/craft_cron/agents/openai.yaml +2 -0
  54. proseview-0.5.0/proseview/skills/craft_guides.json +730 -0
  55. proseview-0.5.0/proseview/skills/craft_king/SKILL.md +11 -0
  56. proseview-0.5.0/proseview/skills/craft_king/agents/openai.yaml +2 -0
  57. proseview-0.5.0/proseview/skills/craft_lamott/SKILL.md +14 -0
  58. proseview-0.5.0/proseview/skills/craft_lamott/agents/openai.yaml +2 -0
  59. proseview-0.5.0/proseview/skills/craft_mckee/SKILL.md +9 -0
  60. proseview-0.5.0/proseview/skills/craft_mckee/agents/openai.yaml +2 -0
  61. proseview-0.5.0/proseview/skills/craft_snyder/SKILL.md +10 -0
  62. proseview-0.5.0/proseview/skills/craft_snyder/agents/openai.yaml +2 -0
  63. proseview-0.5.0/proseview/skills/deepen_and_layer/SKILL.md +13 -0
  64. proseview-0.5.0/proseview/skills/deepen_and_layer/agents/openai.yaml +3 -0
  65. proseview-0.5.0/proseview/skills/layer_subtext/SKILL.md +13 -0
  66. proseview-0.5.0/proseview/skills/layer_subtext/agents/openai.yaml +3 -0
  67. proseview-0.5.0/proseview/skills/next_beats/SKILL.md +14 -0
  68. proseview-0.5.0/proseview/skills/next_beats/agents/openai.yaml +3 -0
  69. proseview-0.5.0/proseview/skills/quick_critique/SKILL.md +17 -0
  70. proseview-0.5.0/proseview/skills/review_guides.json +441 -0
  71. proseview-0.5.0/proseview/skills/scene_continuity/SKILL.md +27 -0
  72. proseview-0.5.0/proseview/skills/update_frontmatter/SKILL.md +12 -0
  73. proseview-0.5.0/proseview/skills/update_frontmatter/agents/openai.yaml +2 -0
  74. proseview-0.5.0/proseview/skills/verify_refactor/SKILL.md +17 -0
  75. {proseview-0.4.2 → proseview-0.5.0}/proseview/snapshot.py +13 -2
  76. proseview-0.5.0/proseview/suggestions.py +1190 -0
  77. proseview-0.5.0/proseview/templates/app/icon-192.png +0 -0
  78. proseview-0.5.0/proseview/templates/app/icon-512.png +0 -0
  79. proseview-0.5.0/proseview/templates/app/icon.svg +1 -0
  80. proseview-0.5.0/proseview/templates/app/manifest.webmanifest +14 -0
  81. proseview-0.5.0/proseview/templates/app/sw.js +17 -0
  82. proseview-0.5.0/proseview/templates/assets/app.css +19612 -0
  83. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/assets/js/00-state.js +78 -36
  84. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/assets/js/01-static-snapshot.js +6 -1
  85. proseview-0.5.0/proseview/templates/assets/js/03-privacy.js +302 -0
  86. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/assets/js/10-prose-indicators.js +9 -4
  87. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/assets/js/12-lossless-markdown.js +39 -1
  88. proseview-0.5.0/proseview/templates/assets/js/13-frontmatter.js +293 -0
  89. proseview-0.5.0/proseview/templates/assets/js/14-callouts.js +296 -0
  90. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/assets/js/15-search.js +150 -5
  91. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/assets/js/19-analysis.js +69 -5
  92. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/assets/js/20-theme-font-charts.js +6 -12
  93. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/assets/js/30-router-modal.js +219 -230
  94. proseview-0.5.0/proseview/templates/assets/js/40-prose-editor.js +1386 -0
  95. proseview-0.5.0/proseview/templates/assets/js/44-pdf-pages.js +795 -0
  96. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/assets/js/45-book.js +332 -4
  97. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/assets/js/50-discard-confirm.js +145 -8
  98. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/assets/js/60-selection.js +353 -58
  99. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/assets/js/65-ai-proposals.js +9 -4
  100. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/assets/js/66-history.js +21 -5
  101. proseview-0.5.0/proseview/templates/assets/js/67-craft-guides.js +3 -0
  102. proseview-0.5.0/proseview/templates/assets/js/67-highlight-card.js +813 -0
  103. proseview-0.5.0/proseview/templates/assets/js/67-review-setup.js +981 -0
  104. proseview-0.5.0/proseview/templates/assets/js/68-discuss.js +10823 -0
  105. proseview-0.5.0/proseview/templates/assets/js/68-sentence-rhythm.js +591 -0
  106. proseview-0.5.0/proseview/templates/assets/js/69-btw.js +932 -0
  107. proseview-0.5.0/proseview/templates/assets/js/69-edit-selection.js +815 -0
  108. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/assets/js/69-file-edit.js +88 -11
  109. proseview-0.5.0/proseview/templates/assets/js/69-group-composer.js +413 -0
  110. proseview-0.5.0/proseview/templates/assets/js/69-group-fork.js +410 -0
  111. proseview-0.5.0/proseview/templates/assets/js/69-group-recap.js +237 -0
  112. proseview-0.5.0/proseview/templates/assets/js/69-group-scroll.js +74 -0
  113. proseview-0.5.0/proseview/templates/assets/js/69-quote-compare.js +75 -0
  114. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/assets/js/70-dashboard.js +203 -26
  115. proseview-0.5.0/proseview/templates/assets/js/70-group-runtime.js +366 -0
  116. proseview-0.5.0/proseview/templates/assets/js/72-beatmap.js +1869 -0
  117. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/assets/js/75-file-management.js +66 -10
  118. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/assets/js/76-export.js +75 -16
  119. proseview-0.5.0/proseview/templates/assets/js/80-settings.js +252 -0
  120. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/assets/js/80-sidebar-init.js +151 -18
  121. proseview-0.5.0/proseview/templates/assets/js/81-suggestion-settings.js +801 -0
  122. proseview-0.5.0/proseview/templates/assets/js/82-beatmap-settings.js +282 -0
  123. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/assets/themes/graphite.css +25 -30
  124. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/index.html.j2 +714 -222
  125. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/vendor/README.md +4 -1
  126. proseview-0.5.0/proseview/templates/vendor/pdfjs/LICENSE +177 -0
  127. proseview-0.5.0/proseview/templates/vendor/pdfjs/pdf.min.mjs +27 -0
  128. proseview-0.5.0/proseview/templates/vendor/pdfjs/pdf.worker.min.mjs +27 -0
  129. proseview-0.5.0/proseview/templates/vendor/pm/prosemirror-gapcursor-1.4.1-X-ZHByb3NlbWlycm9yLW1vZGVsQDEuMjUuNCxwcm9zZW1pcnJvci1zdGF0ZUAxLjQuNCxwcm9zZW1pcnJvci10cmFuc2Zvcm1AMS4xMC40-es2022-prosemirror-gapcursor.js +2 -0
  130. proseview-0.5.0/proseview/templates/vendor/pm/prosemirror-gapcursor.js +6 -0
  131. {proseview-0.4.2 → proseview-0.5.0}/proseview/typst_render.py +22 -1
  132. {proseview-0.4.2 → proseview-0.5.0}/proseview/watch.py +2 -1
  133. proseview-0.5.0/proseview.egg-info/PKG-INFO +428 -0
  134. {proseview-0.4.2 → proseview-0.5.0}/proseview.egg-info/SOURCES.txt +96 -3
  135. {proseview-0.4.2 → proseview-0.5.0}/proseview.egg-info/requires.txt +1 -0
  136. {proseview-0.4.2 → proseview-0.5.0}/pyproject.toml +5 -1
  137. proseview-0.5.0/tests/test_agy_acp_client.py +599 -0
  138. {proseview-0.4.2 → proseview-0.5.0}/tests/test_app_refresh.py +30 -0
  139. proseview-0.5.0/tests/test_beatmap.py +1101 -0
  140. proseview-0.5.0/tests/test_browser.py +108 -0
  141. proseview-0.5.0/tests/test_btw.py +431 -0
  142. proseview-0.5.0/tests/test_builtin_skills.py +146 -0
  143. {proseview-0.4.2 → proseview-0.5.0}/tests/test_bundling.py +32 -2
  144. proseview-0.5.0/tests/test_callout_editor.py +182 -0
  145. proseview-0.5.0/tests/test_callout_exports.py +148 -0
  146. proseview-0.5.0/tests/test_callouts.py +164 -0
  147. proseview-0.5.0/tests/test_citations.py +146 -0
  148. {proseview-0.4.2 → proseview-0.5.0}/tests/test_claude_agent_client.py +399 -1
  149. proseview-0.5.0/tests/test_comedy_review.py +170 -0
  150. {proseview-0.4.2 → proseview-0.5.0}/tests/test_config.py +99 -0
  151. proseview-0.5.0/tests/test_craft_review_context.py +164 -0
  152. {proseview-0.4.2 → proseview-0.5.0}/tests/test_discuss.py +33 -0
  153. {proseview-0.4.2 → proseview-0.5.0}/tests/test_discuss_agent_selection.py +6 -2
  154. {proseview-0.4.2 → proseview-0.5.0}/tests/test_discuss_manager.py +612 -93
  155. {proseview-0.4.2 → proseview-0.5.0}/tests/test_discuss_transport_conformance.py +13 -11
  156. proseview-0.5.0/tests/test_docx.py +324 -0
  157. {proseview-0.4.2 → proseview-0.5.0}/tests/test_export_dashboard.py +114 -7
  158. {proseview-0.4.2 → proseview-0.5.0}/tests/test_generator.py +179 -47
  159. {proseview-0.4.2 → proseview-0.5.0}/tests/test_genre_bands.py +3 -1
  160. {proseview-0.4.2 → proseview-0.5.0}/tests/test_goals.py +26 -0
  161. proseview-0.5.0/tests/test_group.py +390 -0
  162. proseview-0.5.0/tests/test_group_context.py +242 -0
  163. proseview-0.5.0/tests/test_group_fork.py +298 -0
  164. proseview-0.5.0/tests/test_group_polling.py +62 -0
  165. proseview-0.5.0/tests/test_group_progress.py +26 -0
  166. proseview-0.5.0/tests/test_group_runtime.py +521 -0
  167. proseview-0.5.0/tests/test_highlight_suggestions.py +936 -0
  168. proseview-0.5.0/tests/test_highlights.py +549 -0
  169. {proseview-0.4.2 → proseview-0.5.0}/tests/test_history.py +147 -0
  170. {proseview-0.4.2 → proseview-0.5.0}/tests/test_hunks.py +52 -1
  171. proseview-0.5.0/tests/test_ledger.py +59 -0
  172. {proseview-0.4.2 → proseview-0.5.0}/tests/test_obsidian.py +4 -4
  173. {proseview-0.4.2 → proseview-0.5.0}/tests/test_pdf.py +48 -10
  174. proseview-0.5.0/tests/test_privacy.py +222 -0
  175. proseview-0.5.0/tests/test_quote_compare.py +70 -0
  176. {proseview-0.4.2 → proseview-0.5.0}/tests/test_repo.py +25 -0
  177. proseview-0.5.0/tests/test_review_setup.py +424 -0
  178. {proseview-0.4.2 → proseview-0.5.0}/tests/test_scene_prose.py +2 -0
  179. proseview-0.5.0/tests/test_scene_refresh.py +166 -0
  180. proseview-0.5.0/tests/test_send_now.py +361 -0
  181. proseview-0.5.0/tests/test_sentences_and_dialogue.py +110 -0
  182. {proseview-0.4.2 → proseview-0.5.0}/tests/test_server.py +10 -0
  183. {proseview-0.4.2 → proseview-0.5.0}/tests/test_snapshot.py +31 -5
  184. {proseview-0.4.2 → proseview-0.5.0}/tests/test_styles.py +2 -2
  185. {proseview-0.4.2 → proseview-0.5.0}/tests/test_themes.py +9 -29
  186. {proseview-0.4.2 → proseview-0.5.0}/tests/test_watch.py +41 -1
  187. proseview-0.4.2/PKG-INFO +0 -361
  188. proseview-0.4.2/README.md +0 -318
  189. proseview-0.4.2/proseview/highlights.py +0 -263
  190. proseview-0.4.2/proseview/history.py +0 -452
  191. proseview-0.4.2/proseview/related.py +0 -97
  192. proseview-0.4.2/proseview/skills/canon_refactor/SKILL.md +0 -6
  193. proseview-0.4.2/proseview/skills/quick_critique/SKILL.md +0 -31
  194. proseview-0.4.2/proseview/skills/scene_continuity/SKILL.md +0 -6
  195. proseview-0.4.2/proseview/skills/verify_refactor/SKILL.md +0 -5
  196. proseview-0.4.2/proseview/templates/assets/app.css +0 -10301
  197. proseview-0.4.2/proseview/templates/assets/js/13-frontmatter.js +0 -158
  198. proseview-0.4.2/proseview/templates/assets/js/15-overview.js +0 -70
  199. proseview-0.4.2/proseview/templates/assets/js/40-prose-editor.js +0 -791
  200. proseview-0.4.2/proseview/templates/assets/js/68-discuss.js +0 -4762
  201. proseview-0.4.2/proseview/templates/assets/js/80-settings.js +0 -104
  202. proseview-0.4.2/proseview.egg-info/PKG-INFO +0 -361
  203. proseview-0.4.2/tests/test_highlights.py +0 -295
  204. proseview-0.4.2/tests/test_related.py +0 -46
  205. {proseview-0.4.2 → proseview-0.5.0}/LICENSE +0 -0
  206. {proseview-0.4.2 → proseview-0.5.0}/proseview/__main__.py +0 -0
  207. {proseview-0.4.2 → proseview-0.5.0}/proseview/book_styles/classic/style.yaml +0 -0
  208. {proseview-0.4.2 → proseview-0.5.0}/proseview/book_styles/fonts/GreatVibes-Regular.ttf +0 -0
  209. {proseview-0.4.2 → proseview-0.5.0}/proseview/book_styles/fonts/LiberationSerif-Bold.ttf +0 -0
  210. {proseview-0.4.2 → proseview-0.5.0}/proseview/book_styles/fonts/LiberationSerif-BoldItalic.ttf +0 -0
  211. {proseview-0.4.2 → proseview-0.5.0}/proseview/book_styles/fonts/LiberationSerif-Italic.ttf +0 -0
  212. {proseview-0.4.2 → proseview-0.5.0}/proseview/book_styles/fonts/LiberationSerif-Regular.ttf +0 -0
  213. {proseview-0.4.2 → proseview-0.5.0}/proseview/book_styles/fonts/NotoSans-Bold.ttf +0 -0
  214. {proseview-0.4.2 → proseview-0.5.0}/proseview/book_styles/fonts/NotoSans-Regular.ttf +0 -0
  215. {proseview-0.4.2 → proseview-0.5.0}/proseview/book_styles/fonts/OFL.txt +0 -0
  216. {proseview-0.4.2 → proseview-0.5.0}/proseview/book_styles/fonts/README.md +0 -0
  217. {proseview-0.4.2 → proseview-0.5.0}/proseview/book_styles/modern/epub.css +0 -0
  218. {proseview-0.4.2 → proseview-0.5.0}/proseview/book_styles/modern/style.yaml +0 -0
  219. {proseview-0.4.2 → proseview-0.5.0}/proseview/book_styles/romance/epub.css +0 -0
  220. {proseview-0.4.2 → proseview-0.5.0}/proseview/book_styles/romance/style.yaml +0 -0
  221. {proseview-0.4.2 → proseview-0.5.0}/proseview/editor.py +0 -0
  222. {proseview-0.4.2 → proseview-0.5.0}/proseview/epub_check.py +0 -0
  223. {proseview-0.4.2 → proseview-0.5.0}/proseview/patches.py +0 -0
  224. {proseview-0.4.2 → proseview-0.5.0}/proseview/pdf_check.py +0 -0
  225. {proseview-0.4.2 → proseview-0.5.0}/proseview/raw_html.py +0 -0
  226. {proseview-0.4.2 → proseview-0.5.0}/proseview/roster.py +0 -0
  227. {proseview-0.4.2 → proseview-0.5.0}/proseview/skills/canon_refactor/agents/openai.yaml +0 -0
  228. {proseview-0.4.2 → proseview-0.5.0}/proseview/skills/clarify/SKILL.md +0 -0
  229. {proseview-0.4.2 → proseview-0.5.0}/proseview/skills/clarify/agents/openai.yaml +0 -0
  230. {proseview-0.4.2 → proseview-0.5.0}/proseview/skills/clarity_flow/SKILL.md +0 -0
  231. {proseview-0.4.2 → proseview-0.5.0}/proseview/skills/clarity_flow/agents/openai.yaml +0 -0
  232. {proseview-0.4.2 → proseview-0.5.0}/proseview/skills/continuity/SKILL.md +0 -0
  233. {proseview-0.4.2 → proseview-0.5.0}/proseview/skills/continuity/agents/openai.yaml +0 -0
  234. {proseview-0.4.2 → proseview-0.5.0}/proseview/skills/custom_rewrite/SKILL.md +0 -0
  235. {proseview-0.4.2 → proseview-0.5.0}/proseview/skills/custom_rewrite/agents/openai.yaml +0 -0
  236. {proseview-0.4.2 → proseview-0.5.0}/proseview/skills/pacing_tension/SKILL.md +0 -0
  237. {proseview-0.4.2 → proseview-0.5.0}/proseview/skills/pacing_tension/agents/openai.yaml +0 -0
  238. {proseview-0.4.2 → proseview-0.5.0}/proseview/skills/quick_critique/agents/openai.yaml +0 -0
  239. {proseview-0.4.2 → proseview-0.5.0}/proseview/skills/rephrase/SKILL.md +0 -0
  240. {proseview-0.4.2 → proseview-0.5.0}/proseview/skills/rephrase/agents/openai.yaml +0 -0
  241. {proseview-0.4.2 → proseview-0.5.0}/proseview/skills/scene_continuity/agents/openai.yaml +0 -0
  242. {proseview-0.4.2 → proseview-0.5.0}/proseview/skills/sensory_detail/SKILL.md +0 -0
  243. {proseview-0.4.2 → proseview-0.5.0}/proseview/skills/sensory_detail/agents/openai.yaml +0 -0
  244. {proseview-0.4.2 → proseview-0.5.0}/proseview/skills/show_moment/SKILL.md +0 -0
  245. {proseview-0.4.2 → proseview-0.5.0}/proseview/skills/show_moment/agents/openai.yaml +0 -0
  246. {proseview-0.4.2 → proseview-0.5.0}/proseview/skills/style_consistency/SKILL.md +0 -0
  247. {proseview-0.4.2 → proseview-0.5.0}/proseview/skills/style_consistency/agents/openai.yaml +0 -0
  248. {proseview-0.4.2 → proseview-0.5.0}/proseview/skills/tighten/SKILL.md +0 -0
  249. {proseview-0.4.2 → proseview-0.5.0}/proseview/skills/tighten/agents/openai.yaml +0 -0
  250. {proseview-0.4.2 → proseview-0.5.0}/proseview/skills/verify_refactor/agents/openai.yaml +0 -0
  251. {proseview-0.4.2 → proseview-0.5.0}/proseview/skills/voice_character/SKILL.md +0 -0
  252. {proseview-0.4.2 → proseview-0.5.0}/proseview/skills/voice_character/agents/openai.yaml +0 -0
  253. {proseview-0.4.2 → proseview-0.5.0}/proseview/story.py +0 -0
  254. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/assets/js/18-timeline.js +0 -0
  255. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/assets/js/21-appearance-picker.js +0 -0
  256. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/assets/js/77-manuscript-setup.js +0 -0
  257. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/vendor/chart.js +0 -0
  258. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/vendor/chartjs-plugin-annotation.js +0 -0
  259. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/vendor/marked.js +0 -0
  260. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/vendor/pm/entities-4.5.0-es2022-entities.js +0 -0
  261. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/vendor/pm/entities-4.5.0-es2022-lib-decode.js +0 -0
  262. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/vendor/pm/entities-4.5.0-es2022-lib-escape.js +0 -0
  263. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/vendor/pm/entities-4.5.0.js +0 -0
  264. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/vendor/pm/linkify-it-5.0.2-es2022-linkify-it.js +0 -0
  265. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/vendor/pm/linkify-it-5.0.2.js +0 -0
  266. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/vendor/pm/markdown-it-14.0.0.js +0 -0
  267. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/vendor/pm/markdown-it-14.3.0-es2022-markdown-it.js +0 -0
  268. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/vendor/pm/mdurl-2.0.0.js +0 -0
  269. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/vendor/pm/mdurl-2.1.0-es2022-mdurl.js +0 -0
  270. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/vendor/pm/orderedmap-2.0.0.js +0 -0
  271. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/vendor/pm/orderedmap-2.1.1-es2022-orderedmap.js +0 -0
  272. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/vendor/pm/prosemirror-commands-1.7.1-X-ZHByb3NlbWlycm9yLW1vZGVsQDEuMjUuNCxwcm9zZW1pcnJvci1zdGF0ZUAxLjQuNCxwcm9zZW1pcnJvci10cmFuc2Zvcm1AMS4xMC40-es2022-prosemirror-commands.js +0 -0
  273. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/vendor/pm/prosemirror-commands.js +0 -0
  274. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/vendor/pm/prosemirror-history-1.5.0-X-ZHByb3NlbWlycm9yLW1vZGVsQDEuMjUuNCxwcm9zZW1pcnJvci1zdGF0ZUAxLjQuNCxwcm9zZW1pcnJvci10cmFuc2Zvcm1AMS4xMC40-es2022-prosemirror-history.js +0 -0
  275. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/vendor/pm/prosemirror-history.js +0 -0
  276. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/vendor/pm/prosemirror-inputrules-1.4.0-X-ZHByb3NlbWlycm9yLW1vZGVsQDEuMjUuNCxwcm9zZW1pcnJvci1zdGF0ZUAxLjQuNCxwcm9zZW1pcnJvci10cmFuc2Zvcm1AMS4xMC40-es2022-prosemirror-inputrules.js +0 -0
  277. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/vendor/pm/prosemirror-inputrules.js +0 -0
  278. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/vendor/pm/prosemirror-keymap-1.2.3-X-ZHByb3NlbWlycm9yLW1vZGVsQDEuMjUuNCxwcm9zZW1pcnJvci1zdGF0ZUAxLjQuNCxwcm9zZW1pcnJvci10cmFuc2Zvcm1AMS4xMC40-es2022-prosemirror-keymap.js +0 -0
  279. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/vendor/pm/prosemirror-keymap.js +0 -0
  280. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/vendor/pm/prosemirror-markdown-1.13.4-X-ZHByb3NlbWlycm9yLW1vZGVsQDEuMjUuNA-es2022-prosemirror-markdown.js +0 -0
  281. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/vendor/pm/prosemirror-markdown.js +0 -0
  282. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/vendor/pm/prosemirror-model-1.25.4-es2022-prosemirror-model.js +0 -0
  283. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/vendor/pm/prosemirror-model.js +0 -0
  284. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/vendor/pm/prosemirror-schema-list-1.5.0-X-ZHByb3NlbWlycm9yLW1vZGVsQDEuMjUuNCxwcm9zZW1pcnJvci1zdGF0ZUAxLjQuNCxwcm9zZW1pcnJvci10cmFuc2Zvcm1AMS4xMC40-es2022-prosemirror-schema-list.js +0 -0
  285. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/vendor/pm/prosemirror-schema-list.js +0 -0
  286. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/vendor/pm/prosemirror-state-1.4.4-X-ZHByb3NlbWlycm9yLW1vZGVsQDEuMjUuNCxwcm9zZW1pcnJvci10cmFuc2Zvcm1AMS4xMC40-es2022-prosemirror-state.js +0 -0
  287. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/vendor/pm/prosemirror-state.js +0 -0
  288. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/vendor/pm/prosemirror-transform-1.10.4-X-ZHByb3NlbWlycm9yLW1vZGVsQDEuMjUuNA-es2022-prosemirror-transform.js +0 -0
  289. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/vendor/pm/prosemirror-view-1.41.8-X-ZHByb3NlbWlycm9yLW1vZGVsQDEuMjUuNCxwcm9zZW1pcnJvci1zdGF0ZUAxLjQuNCxwcm9zZW1pcnJvci10cmFuc2Zvcm1AMS4xMC40-es2022-prosemirror-view.js +0 -0
  290. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/vendor/pm/prosemirror-view.js +0 -0
  291. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/vendor/pm/punycode.js-2.3.1-es2022-punycode.js +0 -0
  292. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/vendor/pm/punycode.js-2.3.1.js +0 -0
  293. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/vendor/pm/rope-sequence-1.3.0.js +0 -0
  294. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/vendor/pm/rope-sequence-1.3.4-es2022-rope-sequence.js +0 -0
  295. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/vendor/pm/uc.micro-2.0.0.js +0 -0
  296. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/vendor/pm/uc.micro-2.1.0-es2022-uc.micro.js +0 -0
  297. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/vendor/pm/uc.micro-2.1.0.js +0 -0
  298. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/vendor/pm/w3c-keyname-2.2.0.js +0 -0
  299. {proseview-0.4.2 → proseview-0.5.0}/proseview/templates/vendor/pm/w3c-keyname-2.2.8-es2022-w3c-keyname.js +0 -0
  300. {proseview-0.4.2 → proseview-0.5.0}/proseview.egg-info/dependency_links.txt +0 -0
  301. {proseview-0.4.2 → proseview-0.5.0}/proseview.egg-info/entry_points.txt +0 -0
  302. {proseview-0.4.2 → proseview-0.5.0}/proseview.egg-info/top_level.txt +0 -0
  303. {proseview-0.4.2 → proseview-0.5.0}/setup.cfg +0 -0
  304. {proseview-0.4.2 → proseview-0.5.0}/tests/test_annotations.py +0 -0
  305. {proseview-0.4.2 → proseview-0.5.0}/tests/test_app_selection.py +0 -0
  306. {proseview-0.4.2 → proseview-0.5.0}/tests/test_backups.py +0 -0
  307. {proseview-0.4.2 → proseview-0.5.0}/tests/test_book.py +0 -0
  308. {proseview-0.4.2 → proseview-0.5.0}/tests/test_claude_permissions.py +0 -0
  309. {proseview-0.4.2 → proseview-0.5.0}/tests/test_cli.py +0 -0
  310. {proseview-0.4.2 → proseview-0.5.0}/tests/test_codex_app_server.py +0 -0
  311. {proseview-0.4.2 → proseview-0.5.0}/tests/test_editor.py +0 -0
  312. {proseview-0.4.2 → proseview-0.5.0}/tests/test_epub.py +0 -0
  313. {proseview-0.4.2 → proseview-0.5.0}/tests/test_export.py +0 -0
  314. {proseview-0.4.2 → proseview-0.5.0}/tests/test_frontmatter_scaffold.py +0 -0
  315. {proseview-0.4.2 → proseview-0.5.0}/tests/test_images.py +0 -0
  316. {proseview-0.4.2 → proseview-0.5.0}/tests/test_layouts.py +0 -0
  317. {proseview-0.4.2 → proseview-0.5.0}/tests/test_lossless_markdown.py +0 -0
  318. {proseview-0.4.2 → proseview-0.5.0}/tests/test_manuscript_edge_cases.py +0 -0
  319. {proseview-0.4.2 → proseview-0.5.0}/tests/test_matter.py +0 -0
  320. {proseview-0.4.2 → proseview-0.5.0}/tests/test_note_edit.py +0 -0
  321. {proseview-0.4.2 → proseview-0.5.0}/tests/test_patches.py +0 -0
  322. {proseview-0.4.2 → proseview-0.5.0}/tests/test_platform.py +0 -0
  323. {proseview-0.4.2 → proseview-0.5.0}/tests/test_raw_html.py +0 -0
  324. {proseview-0.4.2 → proseview-0.5.0}/tests/test_release.py +0 -0
  325. {proseview-0.4.2 → proseview-0.5.0}/tests/test_roster.py +0 -0
  326. {proseview-0.4.2 → proseview-0.5.0}/tests/test_scale.py +0 -0
  327. {proseview-0.4.2 → proseview-0.5.0}/tests/test_story.py +0 -0
@@ -0,0 +1,428 @@
1
+ Metadata-Version: 2.4
2
+ Name: proseview
3
+ Version: 0.5.0
4
+ Summary: A writing studio for novels in plain Markdown.
5
+ Author: Ari Saif
6
+ License: MIT
7
+ Project-URL: Homepage, https://github.com/ourarash/proseview
8
+ Project-URL: Source, https://github.com/ourarash/proseview
9
+ Project-URL: Issues, https://github.com/ourarash/proseview/issues
10
+ Keywords: writing,novel,markdown,dashboard,lexical-analysis,prose
11
+ Classifier: Development Status :: 3 - Alpha
12
+ Classifier: Environment :: Console
13
+ Classifier: Environment :: Web Environment
14
+ Classifier: Intended Audience :: End Users/Desktop
15
+ Classifier: License :: OSI Approved :: MIT License
16
+ Classifier: Operating System :: MacOS :: MacOS X
17
+ Classifier: Operating System :: POSIX :: Linux
18
+ Classifier: Operating System :: Microsoft :: Windows
19
+ Classifier: Programming Language :: Python :: 3
20
+ Classifier: Programming Language :: Python :: 3.11
21
+ Classifier: Programming Language :: Python :: 3.12
22
+ Classifier: Programming Language :: Python :: 3.13
23
+ Classifier: Topic :: Text Processing :: Markup
24
+ Requires-Python: >=3.11
25
+ Description-Content-Type: text/markdown
26
+ License-File: LICENSE
27
+ Requires-Dist: Jinja2>=3.1
28
+ Requires-Dist: json_repair>=0.30
29
+ Requires-Dist: markdown-it-py>=3.0
30
+ Requires-Dist: PyYAML>=6.0
31
+ Requires-Dist: ruamel.yaml>=0.17
32
+ Requires-Dist: typst>=0.15
33
+ Provides-Extra: claude
34
+ Requires-Dist: claude-agent-sdk>=0.2; extra == "claude"
35
+ Provides-Extra: dev
36
+ Requires-Dist: pytest>=7; extra == "dev"
37
+ Requires-Dist: pytest-xdist>=3.5; extra == "dev"
38
+ Provides-Extra: e2e
39
+ Requires-Dist: pytest>=7; extra == "e2e"
40
+ Requires-Dist: playwright>=1.44; extra == "e2e"
41
+ Requires-Dist: pytest-playwright>=0.5; extra == "e2e"
42
+ Requires-Dist: pytest-xdist>=3.5; extra == "e2e"
43
+ Dynamic: license-file
44
+
45
+ # Proseview
46
+
47
+ **A writing studio for novels in plain Markdown.**
48
+
49
+ [![CI](https://github.com/ourarash/proseview/actions/workflows/ci.yml/badge.svg)](https://github.com/ourarash/proseview/actions/workflows/ci.yml)
50
+ ![status](https://img.shields.io/badge/status-alpha-orange)
51
+ ![python](https://img.shields.io/badge/python-3.11%2B-blue)
52
+ ![platform](https://img.shields.io/badge/platform-macOS%20%7C%20Linux%20%7C%20Windows-lightgrey)
53
+ ![license](https://img.shields.io/badge/license-MIT-green)
54
+
55
+ [Website](https://ourarash.github.io/proseview/) ·
56
+ [Try a sample book](https://ourarash.github.io/proseview/demo/#/scene/ch01%2F01-down-the-rabbit-hole.md) ·
57
+ [Start a book in your browser](https://ourarash.github.io/proseview/write/) ·
58
+ [Quick start](#quick-start)
59
+
60
+ Proseview turns a folder of Markdown scenes into a place to write, structure, revise, and publish a book.
61
+
62
+ You read and edit each scene in clean book typography instead of looking at raw Markdown code (`#`, `**`, YAML). Your files stay plain `.md` on your computer, so you can keep using Obsidian, VS Code, Vim, or Git alongside it. A save changes only what you edited.
63
+
64
+ Everything runs locally on your machine: no account, no subscription, no database, and no telemetry. AI is optional and off until you ask; without it, Proseview is still a complete writing studio that works offline.
65
+
66
+ ```bash
67
+ pipx install proseview
68
+ proseview --root /path/to/your/novel
69
+ ```
70
+
71
+ ![The Proseview dashboard with the file sidebar open on chapter one's scenes: a Progress card with the words against the goal, today's words, words a day, the writing streak, words per chapter and days to finish, above the scene list](https://raw.githubusercontent.com/ourarash/proseview/main/docs/images/dashboard.png)
72
+
73
+ **Try it first.** The [sample book](https://ourarash.github.io/proseview/demo/#/scene/ch01%2F01-down-the-rabbit-hole.md)
74
+ is the dashboard for *Alice's Adventures in Wonderland*, in your browser: read,
75
+ search, open the analysis, edit a scene and export it. [Start a book in your
76
+ browser](https://ourarash.github.io/proseview/write/) runs Proseview itself
77
+ with nothing to install; the book stays in that browser, and you can download
78
+ it as a folder to carry on in the installed app.
79
+
80
+ ## Features
81
+
82
+ ### Write and draft
83
+
84
+ - **Read like a book, edit in place.** Your prose appears with comfortable
85
+ margins, serif type, and dialogue formatting, with no Markdown symbols in the
86
+ way.
87
+ Press `E` to edit directly on the page with the same typography; press `Mod-S`
88
+ to save and return to reading.
89
+ - **Conflict guard.** If you edit a scene in Obsidian, Vim, or any external
90
+ editor while Proseview is open, Proseview prevents overwriting it and shows a
91
+ side-by-side diff of what changed on disk.
92
+ - **Drafting aids and callouts.** Highlight any line to reformat it, add a
93
+ callout box (`> [!letter]` for letters or text messages), or drop in an inline
94
+ `<!-- TODO -->` or `<!-- NOTE -->` without leaving your drafting flow.
95
+ - **Read the book.** Read the whole manuscript as one continuous text, or turn
96
+ on **Print layout** to read facing pages with running heads and chapter drops
97
+ exactly as Export will print them. It reopens where you stopped.
98
+ - **Every Markdown file.** Story bibles, character bios, and worldbuilding
99
+ notes open and edit the same way, with automatic backups. Obsidian wikilinks,
100
+ callouts, and embeds stay as written.
101
+ - **Files and search.** Create, rename, and move scenes from the sidebar;
102
+ `Mod-K` searches scene titles, YAML metadata, TODOs, notes, and prose across
103
+ the whole book.
104
+ - **Privacy screen.** Press `Mod-J J` (hold `Mod` and tap `J` twice) to instantly
105
+ cover the page with a plain budget spreadsheet; do it again to uncover your
106
+ prose, caret, and scroll exactly where you left them.
107
+ [Optional password →](docs/configuration.md#privacy-screen-password)
108
+
109
+ ### Structure and story
110
+
111
+ - **Beat Map.** Your agent reads a scene and maps how it moves: its beats on
112
+ an estimated tension curve (from calm to crisis), and its moments by kind:
113
+ dialogue, action, inner thought, or silent reaction. Click a moment to jump
114
+ to its paragraph. It is made only when you ask, and is marked out of date
115
+ when the scene changes.
116
+ - **Timeline and storylines.** See the proportion of your chapters, words per
117
+ scene, and storylines as parallel lanes. Compare reading order against story
118
+ chronology so flashbacks and out-of-order scenes are easy to audit.
119
+ - **Character presence and pairings.** See which chapters each character
120
+ appears in, and check a co-occurrence chart to see which characters share
121
+ scenes and who never meets.
122
+ - **Progress and What changed.** A Progress card tracking words against your
123
+ goal, today's word count, writing pace, and streak. **What changed** shows
124
+ the words written and cut scene by scene, either by period or against a Git
125
+ commit.
126
+
127
+ ### Revise
128
+
129
+ - **13 Editorial passes.** Built-in checks mark the page with quiet underlines
130
+ and match counts:
131
+ - *Pacing and flow:* sticky sentences (glue words that slow a sentence
132
+ down) and repeated sentence openings.
133
+ - *Repetition:* echoes (a word back within 50 words) and the scene's most
134
+ repeated words.
135
+ - *Clarity and style:* passive voice, filter verbs ("she heard", "he saw"),
136
+ crutch words, hyperbole, figurative language, and sensory details.
137
+ - *Dialogue and POV:* dialogue tags (fancy verbs, adverbs, long runs with no
138
+ tag), all speech tinted, and first-person slips in third-person scenes.
139
+ - **Highlight cards.** Click any mark for a short note on what the check
140
+ found. With an agent, **Suggest** offers rewrites in the card, and one click
141
+ applies one.
142
+ - **Word variety (MATTR & MTLD).** Tracks vocabulary richness across nearby
143
+ words and whole scenes against typical ranges for your genre (contemporary,
144
+ literary, speculative, or children's). Every metric includes an ⓘ explaining
145
+ how it is measured. [What the numbers mean →](docs/analytics.md)
146
+ - **Tasks and notes.** Aggregates every `TODO` and tagged `NOTE` comment across
147
+ all scene files into one place so you don't lose track of revision thoughts.
148
+ - **File history.** Step back through earlier versions of a scene, comparing
149
+ changes in a side-by-side or inline diff before restoring.
150
+
151
+ ### Publish
152
+
153
+ - **Print-ready PDF.** Typesets a paperback interior using Typst across
154
+ standard trim sizes (5 × 8, 5.25 × 8, 5.5 × 8.5, 6 × 9 in, or A5). Includes
155
+ recto chapter starts, running heads, and page numbers.
156
+ - **EPUB e-books.** Exports clean, store-ready EPUB3 files with your cover art,
157
+ metadata, and formatted chapters.
158
+ - **Word documents (`.docx`).** Exports formatted manuscripts for editors or
159
+ beta readers, including standard submission manuscript format with support for
160
+ tracked changes.
161
+ - **Interactive print preview.** Preview the facing pages, trim sizes, and
162
+ typography before exporting. [Export guide →](docs/export.md)
163
+ - **A read-only copy to share.** `proseview snapshot` compiles the dashboard
164
+ into a static website you can host anywhere (such as GitHub Pages) for beta
165
+ readers to browse. [Details →](#share-a-read-only-copy)
166
+
167
+ ### Working with an agent (optional)
168
+
169
+ Proseview has no AI model of its own and needs no API keys. It drives the
170
+ Codex, Claude, or Agy (Antigravity) command-line tools already installed and
171
+ signed in on your computer, so your agent works under your own account and its
172
+ own privacy terms. Proseview itself sends nothing anywhere.
173
+
174
+ Nothing runs until you ask:
175
+
176
+ - **The Group: editors that debate.** Two or three editors in one
177
+ conversation, each on its own agent: Codex, Claude, or Agy. A **Story
178
+ Editor** and a **Voice Editor** by default; add a **Continuity Editor** for
179
+ three. They read the same scene and answer each other, agreeing, pushing
180
+ back, or passing, so different models check each other's notes. `@mention` one to ask just them.
181
+ A recap lists what they agreed on, the choices left to you, and each edit as
182
+ Before and After. **Send to Group** takes any finished chat there for a
183
+ second opinion.
184
+ - **Scene reviews.** Run a review on a scene, its neighbors, or a whole
185
+ chapter: **Quick critique**, **Deepen & layer**, **Craft review** through a
186
+ writing book (McKee, Coyne, Cron, Snyder, King, or Lamott), or **Comedy
187
+ review**. Each finding quotes the passage (**Before**), says what goes wrong
188
+ for the reader (**Why**), and gives a replacement you can paste (**After**).
189
+ Choose the lanes to look at and how many findings to get.
190
+ - **Compare and apply.** **Compare** shows a suggestion against the passage as
191
+ it stands now. Tick the findings you want, add a note to any of them, and
192
+ ask the agent to apply them.
193
+ - **Codex, Claude, and Agy tabs.** One tab per agent in the side panel, each
194
+ with its own conversation. Agy is the Antigravity CLI, which brings Gemini
195
+ models. Mention files with `@` or select prose to ask
196
+ about it.
197
+ - **Edits you can see.** An edit an agent makes is saved and shown in a card
198
+ with the diff, **Undo all** and **Looks good**.
199
+ - **Continuity checks.** Ask whether a passage fits the rest of the book, and
200
+ the answer cites the lines it relies on.
201
+
202
+ [How the AI features work →](docs/ai.md)
203
+
204
+ ## Everyday shortcuts
205
+
206
+ | Key | Action |
207
+ | :--- | :--- |
208
+ | `E` | Edit the scene you are reading |
209
+ | `Mod-S` | Save edits and return to reading |
210
+ | `Mod-K` | Search scenes, notes, and prose |
211
+ | `Mod-J J` | Cover / uncover with the privacy screen |
212
+ | `P` | Polish the selected prose with your agent |
213
+ | `A` | Ask an agent about the selected passage |
214
+ | `X` | Open the Export dialog |
215
+ | `F` / `Shift-F` | Distraction-free focus layout / Fullscreen |
216
+
217
+ ## Screenshots
218
+
219
+ ### Editorial passes
220
+
221
+ Each prose pass shows its match count for the scene; switching one on marks
222
+ the page you are reading.
223
+
224
+ ![The Analysis panel open beside a scene, with four highlight passes switched on from their rows and the matching words marked in the prose](https://raw.githubusercontent.com/ourarash/proseview/main/docs/images/demo-highlights.gif)
225
+
226
+ ### Editing
227
+
228
+ `Edit` turns the page you were reading into the page you type into, with the
229
+ same typography. `Mod-S` saves the file and returns to reading. A scene's
230
+ frontmatter sits above its prose as YAML you can edit, and a typo that is not
231
+ valid YAML is pointed out rather than saved.
232
+
233
+ ![Typing a new closing line into a scene and saving it with Mod-S, with the word count updating](https://raw.githubusercontent.com/ourarash/proseview/main/docs/images/demo-writing.gif)
234
+
235
+ ### Read the book
236
+
237
+ The whole manuscript as one continuous text, with a quiet bar for progress,
238
+ scene and chapter skips and a chapter list. **Print layout** shows the same
239
+ book as Export lays it out, page by page, in your chosen style and trim.
240
+
241
+ ![Read the book: the opening of the demo manuscript as one continuous text, with the progress and chapter bar along the bottom](https://raw.githubusercontent.com/ourarash/proseview/main/docs/images/read-the-book.png)
242
+
243
+ ### Analysis
244
+
245
+ ![The Analysis tab: What stands out, in plain sentences that name the scenes, above a chart of how many scenes each character is in, chapter by chapter](https://raw.githubusercontent.com/ourarash/proseview/main/docs/images/analytics.png)
246
+
247
+ ### Timeline
248
+
249
+ Chapter proportions, words per scene, storylines as lanes, and reading order
250
+ against the order events happen, so a scene read far from where it happens is
251
+ easy to spot.
252
+
253
+ ![The Timeline tab showing chapter proportion, words per scene, three storyline lanes, and reading order against story order, with a scene card on hover](https://raw.githubusercontent.com/ourarash/proseview/main/docs/images/demo-timeline.gif)
254
+
255
+ ### Beat Map
256
+
257
+ Your agent maps a scene's beats on a tension line and lists its moments by
258
+ kind. Click a moment and the page shows its paragraph.
259
+
260
+ ![The Beats tab beside the opening scene: a tension line across five beats, the first beat open to its moments, and the chosen moment's sentence marked in the prose](https://raw.githubusercontent.com/ourarash/proseview/main/docs/images/demo-beatmap.gif)
261
+
262
+ ### Scene reviews
263
+
264
+ Run a review from the agent's tab. Each finding quotes the passage, says why
265
+ it matters, and gives a replacement you can paste; **Compare** shows it
266
+ against the scene as it stands. Tick the findings you want, add a note,
267
+ and **Prepare request** asks the agent to apply them; the saved edit comes
268
+ back as a card you can undo.
269
+
270
+ ![A Quick critique on Codex: findings with the quoted passage, the reason and a replacement; Compare showing one suggestion against the current passage; two findings ticked, one with a note; Prepare request filling in "Apply items 1, 2"; and Codex's saved edit with Undo all and Looks good](https://raw.githubusercontent.com/ourarash/proseview/main/docs/images/demo-review.gif)
271
+
272
+ ### Group
273
+
274
+ Editors on different agents debate one question in one conversation: here
275
+ the Story Editor on Codex, the Voice Editor on Claude, and the Continuity
276
+ Editor on Agy, each answering the others.
277
+
278
+ ![The Group tab: the Story Editor on Codex, the Voice Editor on Claude and the Continuity Editor on Agy debating whether a passage in the opening scene should stay](https://raw.githubusercontent.com/ourarash/proseview/main/docs/images/demo-room.gif)
279
+
280
+ ### Agents
281
+
282
+ Codex, Claude, and Agy each keep their own conversation. Opening another file does
283
+ not reset either one; the next question simply says which file you are in.
284
+
285
+ ![The Codex and Claude tabs answering the same question about a scene in separate conversations, with each answer staying in its own tab](https://raw.githubusercontent.com/ourarash/proseview/main/docs/images/demo-agents.gif)
286
+
287
+ ### Search
288
+
289
+ ![The search palette open over a scene, showing file, scene, and prose matches grouped by kind](https://raw.githubusercontent.com/ourarash/proseview/main/docs/images/demo-search.gif)
290
+
291
+ ### Export
292
+
293
+ Choose the format and style, then see the pages exactly as the file will be.
294
+
295
+ ![The Export dialog's second step: format cards for E-book, Print book, Shareable PDF and All formats, the print book's trim size and right-hand chapter option, and thumbnails of the Classic, Modern and Romance styles](https://raw.githubusercontent.com/ourarash/proseview/main/docs/images/export-formats.png)
296
+
297
+ ![The Export dialog's third step: title, author and cover beside a preview of the print book showing two facing pages with running heads and page numbers](https://raw.githubusercontent.com/ourarash/proseview/main/docs/images/export-preview.png)
298
+
299
+ The screenshots use the bundled demo manuscript, *Alice's Adventures in
300
+ Wonderland* (public domain), split into 39 scenes across 12 chapters. See
301
+ [fixtures/demo-book](fixtures/demo-book/README.md).
302
+
303
+ ## Quick start
304
+
305
+ Requires Python 3.11+ on macOS, Linux or Windows.
306
+
307
+ ```bash
308
+ pipx install proseview
309
+ proseview --root /path/to/your/novel
310
+ ```
311
+
312
+ A browser tab opens at `http://localhost:7842`; press Ctrl-C to stop. If you
313
+ want to use Claude in the side panel, install the `[claude]` extra instead:
314
+ `pipx install "proseview[claude]"`.
315
+
316
+ Proseview's book features read a `manuscript/` folder with one folder per
317
+ chapter and one Markdown file per scene. Frontmatter is optional. Point it at a
318
+ folder without a manuscript, such as an Obsidian vault, and it opens as plain
319
+ Markdown you can read, edit and search; **Choose manuscript folder…** tells it
320
+ where the book is.
321
+
322
+ ```text
323
+ my-novel/
324
+ ├── manuscript/
325
+ │ ├── ch01/
326
+ │ │ ├── 01-opening.md
327
+ │ │ └── 02-meeting.md
328
+ │ └── ch02/
329
+ │ └── 01-aftermath.md
330
+ └── .proseview.yaml # optional
331
+ ```
332
+
333
+ [Layout and frontmatter →](docs/manuscript.md)
334
+
335
+ ### Open it as an app
336
+
337
+ In Chrome or Edge, click the install icon at the right of the address bar.
338
+ The dashboard then opens in its own window with its own Dock or taskbar icon.
339
+ It is still the local server underneath, so start `proseview` first; opened
340
+ without it, the window says so. The app is tied to `localhost:7842`: it shows
341
+ whichever book is served there, and a book that falls back to another port
342
+ opens in the browser as before.
343
+
344
+ ### Share a read-only copy
345
+
346
+ ```bash
347
+ proseview snapshot --root /path/to/your/novel --out ~/my-novel-site
348
+ ```
349
+
350
+ This writes the dashboard as static files any web host can serve, including
351
+ GitHub Pages. Readers can browse scenes, search and read the analysis; nothing
352
+ on it edits and no server runs, and paths from your computer are replaced by
353
+ the folder's name. `--demo` also lets visitors try editing (saved only in their
354
+ browser) and download ready-made EPUB, PDF and Word files. `--title`,
355
+ `--site-url` and `--preview-image` set how a link to it looks when shared.
356
+
357
+ ## CLI commands
358
+
359
+ | Command | Description |
360
+ | :--- | :--- |
361
+ | `proseview serve` | Start the local dashboard server (default) |
362
+ | `proseview export` | Compile the manuscript into an EPUB, PDF, or Word document |
363
+ | `proseview snapshot` | Write a read-only copy of the dashboard as static files |
364
+ | `proseview roster` | Suggest character names found in the manuscript prose |
365
+ | `proseview privacy-password` | Set or change the password that uncovers the privacy screen |
366
+ | `proseview init` | Write a starter `.proseview.yaml` in the book's folder |
367
+
368
+ ## Configuration
369
+
370
+ Proseview needs no config file. A `.proseview.yaml` at the root of the book can
371
+ change where things live, set word goals, choose which agent tab opens first,
372
+ or point the Timeline at your own frontmatter keys; `proseview init` writes a
373
+ starter file. Goals, word variety (genre), and color theme can also be changed
374
+ in Settings, behind the gear in the header.
375
+
376
+ ```yaml
377
+ manuscript_path: manuscript/
378
+ target_words: 80000
379
+ discuss:
380
+ agent: codex
381
+ ```
382
+
383
+ [Every key, with defaults →](docs/configuration.md)
384
+
385
+ ## Documentation
386
+
387
+ - [Manuscript layout and frontmatter](docs/manuscript.md)
388
+ - [Configuration reference](docs/configuration.md)
389
+ - [Working with AI](docs/ai.md)
390
+ - [What the numbers mean](docs/analytics.md)
391
+ - [Exporting: EPUB, PDF and Word](docs/export.md)
392
+
393
+ ## Status
394
+
395
+ Proseview is alpha: everything described above works today. Still unfinished:
396
+
397
+ - The `$` skill picker on the Claude tab lists only Codex's skills; Claude
398
+ still uses your Claude skills on its own.
399
+ - Read the book does not yet update live when a scene changes on disk.
400
+
401
+ The full list is in [plans/roadmap.md](plans/roadmap.md).
402
+
403
+ ## Development
404
+
405
+ ```bash
406
+ pip install -e ".[dev]"
407
+ pytest
408
+ ```
409
+
410
+ This runs over a thousand unit tests and an HTTP end-to-end tier that starts a
411
+ real `proseview` process and checks what reaches the disk: saves and the
412
+ conflict guard, TODOs and notes, the agent bridge and live reload. Agent tests
413
+ use a deterministic fake and never contact Codex, Claude or the network.
414
+
415
+ A browser tier drives the real interface in Chromium:
416
+
417
+ ```bash
418
+ pip install -e ".[e2e]"
419
+ python -m playwright install chromium
420
+ pytest -m e2e_browser
421
+ ```
422
+
423
+ Both tiers work on a throwaway copy of `fixtures/demo-repo`. See
424
+ [CONTRIBUTING.md](CONTRIBUTING.md).
425
+
426
+ ## License
427
+
428
+ MIT. See [LICENSE](LICENSE).