obsidian-plugin/lllin000_PaperForge
1
0
Fork 0
mirror of https://github.com/lllin000/PaperForge.git synced 2026-07-22 06:50:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
1769 commits 4 branches 19 tags 51 MiB
Python 79%
TypeScript 12.9%
JavaScript 6.1%
CSS 1.7%
Shell 0.2%
Other 0.1%
Find a file
LLLin000 6afcdc1830 fix: PR8.1 — status healthy init + object_units rebuild + version bump 
- status.py: healthy=True init before if exists: (was UnboundLocalError
  when vector DB doesn't exist)
- manifest.py: RETRIEVAL_POLICY_VERSION l4.body.v1 → l4.body.v2 to
  trigger object_units rebuild with PR7 fix (unit_id fallback)
- Object_units corrected from 20→311 after rebuild (was INSERT OR
  REPLACE overwrite from old empty unit_id)
- Coverage parity: 20 papers have body_units = 20 have object_units ✅
  (body=811 chunks, object=311 chunks, expected difference due to
   section-split vs 1:1 caption structure)
- Unit tests: 97 pass (subset)
2026-07-06 20:08:51 +08:00
.agents/skills A2: check table ownership (consumed_table_block_keys) before _SKIPPED_BODY_ROLES in render loop 2026-06-25 22:27:35 +08:00
.github test: clean up brittle and low-value tests 2026-05-24 20:00:47 +08:00
.husky Add pre-commit hooks (husky + lint-staged + prettier) 2026-06-25 16:42:34 +08:00
.omp fix: support Roman numeral and S-prefix table captions across roles/signatures/tables 2026-07-02 00:47:18 +08:00
.opencode fix: heading detection, backmatter, table consumed, footnote reorder, figure crop + audit fixtures 2026-06-22 01:28:55 +08:00
.planning fix: support Roman numeral and S-prefix table captions across roles/signatures/tables 2026-07-02 00:47:18 +08:00
.tmp/tail_pdf_samples feat(ocr): tail regime remediation + style-aware heading profiles + boundary detection 2026-06-05 22:47:13 +08:00
audit chore: gitignore audit per-paper dirs, delete stale annotated_pages, update AGENTS.md 2026-07-03 02:03:12 +08:00
docs feat: PR 8 — Object Vector Retrieval (paperforge_objects collection) 2026-07-06 19:58:46 +08:00
fixtures feat: surface OCR structured health in doctor and status 2026-06-05 10:35:23 +08:00
node_modules A2: check table ownership (consumed_table_block_keys) before _SKIPPED_BODY_ROLES in render loop 2026-06-25 22:27:35 +08:00
paperforge fix: PR8.1 — status healthy init + object_units rebuild + version bump 2026-07-06 20:08:51 +08:00
project docs: mark Layer 2 done, update project docs 2026-07-04 23:41:59 +08:00
scripts feat: enable OCR_PIPELINE_V3 by default 2026-07-04 20:04:39 +08:00
tests feat: PR 8 — Object Vector Retrieval (paperforge_objects collection) 2026-07-06 19:58:46 +08:00
%TEMP%test_import.py fix: final hardening — policy revision + Layer A all green 2026-07-06 19:08:54 +08:00
.gitignore chore: gitignore audit per-paper dirs, delete stale annotated_pages, update AGENTS.md 2026-07-03 02:03:12 +08:00
.pre-commit-config.yaml chore: add PR template + pre-commit config (ruff auto-format) 2026-05-10 12:04:12 +08:00
_master_funcs.txt feat(ocr): journal layout generalization, OCR diagnostics, and debug scripts 2026-06-06 00:46:49 +08:00
AGENTS.md feat: layout-category truth audit complete 2026-07-04 21:26:15 +08:00
CHANGELOG.md docs: CHANGELOG 1.5.9 - tail rendering fix 2026-06-17 01:33:21 +08:00
CONTEXT-MAP.md docs: design Layer 4 retrieval substrate 2026-07-05 02:05:27 +08:00
CONTEXT.md fix(ocr-quality): contract polish — 4 P0/P1 fixes 2026-07-04 23:38:03 +08:00
CONTRIBUTING.md docs: add CONTRIBUTING.md — sync fork guide and PR checklist 2026-05-10 12:02:07 +08:00
INSTALLATION.md docs: replace git+https install URLs with pip install paperforge (PyPI) 2026-05-11 19:25:38 +08:00
LICENSE docs: add CC BY-NC-SA 4.0 license and acknowledgments 2026-05-01 11:37:50 +08:00
manifest.json bump: 1.5.14 -> 1.5.15 2026-06-01 19:46:46 +08:00
OCR-V2-READINESS-SUMMARY.md docs: add OCR-v2 readiness summary for agent handoff 2026-06-19 00:44:00 +08:00
package-lock.json Add pre-commit hooks (husky + lint-staged + prettier) 2026-06-25 16:42:34 +08:00
package.json Add pre-commit hooks (husky + lint-staged + prettier) 2026-06-25 16:42:34 +08:00
paperforge.json refactor: __init__.py as single version source; pyproject.toml reads dynamically; paperforge.json drops version field 2026-04-28 22:41:48 +08:00
PROJECT-MANAGEMENT.md docs: mark Layer 2 done, update project docs 2026-07-04 23:41:59 +08:00
pyproject.toml feat(ocr-quality): add evaluate_readiness() with YAML policy evaluator 2026-07-04 23:28:06 +08:00
README.en.md docs: reset documentation IA (readme entry pages, tutorial/troubleshooting split, AGENTS agent-only, pure command ref, maintainer guide) 2026-05-16 22:47:00 +08:00
README.md docs: reset documentation IA (readme entry pages, tutorial/troubleshooting split, AGENTS agent-only, pure command ref, maintainer guide) 2026-05-16 22:47:00 +08:00
README.zh-CN.md docs: redesign README with banner and dashboard preview 2026-05-02 14:52:59 +08:00
README.zh.md docs: expand memory and embedding layer description in architecture 2026-05-19 02:07:53 +08:00
requirements.txt fix: add textual to requirements.txt 2026-04-23 00:09:00 +08:00
REVIEW.md docs: update REVIEW and coverage ledger 2026-06-19 15:20:15 +08:00
skills-lock.json A2: check table ownership (consumed_table_block_keys) before _SKIPPED_BODY_ROLES in render loop 2026-06-25 22:27:35 +08:00

README.en.md

PaperForge banner

PaperForge

Version Python License

简体中文 · English

铸知识为器，启洞见之明。 — Forge Knowledge, Empower Insight.

PaperForge brings your Zotero library into Obsidian. Sync papers, run OCR, extract figures, and do AI-assisted deep reading — all inside a single vault.

0. What PaperForge Is

PaperForge is not just an Obsidian plugin. It has two parts:

Part What Does Where
Obsidian Plugin main.js + manifest.json + styles.css Dashboard, buttons, settings UI .obsidian/plugins/paperforge/ in your vault
Python Package paperforge Sync, OCR, Doctor, repair Your system Python (pip install)

The plugin is the interface. The Python package is the engine. Every button you click in the plugin actually runs a Python command behind the scenes.

After installing the plugin, you MUST verify that the Python package is also installed and version-matched.

1. Install the Obsidian Plugin

Option A: BRAT (Recommended)

  1. Install BRAT from the Obsidian community plugin browser
  2. Open BRAT settings → Add Beta Plugin
  3. Enter: https://github.com/LLLin000/PaperForge
  4. BRAT downloads the latest main.js, manifest.json, and styles.css and installs them
  5. Settings → Community Plugins → enable PaperForge

BRAT auto-detects GitHub Release updates. No manual downloads needed.

Option B: Manual Download

  1. Go to Releases
  2. Download the three files: main.js, manifest.json, styles.css
  3. Create .obsidian/plugins/paperforge/ in your vault
  4. Put the three files there
  5. Restart Obsidian → Settings → Community Plugins → enable PaperForge

Manual install does not auto-update. You'll need to re-download for each new version.

2. Install the Python Package

After enabling the plugin, open the PaperForge settings tab. You'll see a Runtime Status section:

Plugin v1.5.0 → Python Package v1.5.0 ✓ Matched
  • If it says "Not installed" → click Open Wizard to re-run the setup process
  • If it says "Mismatch" → the Python package auto-updates when the plugin updates. If it didn't succeed, click Update Runtime to manually trigger

3. Quickstart

# 1. Export from Zotero (Better BibTeX JSON, Keep updated) to exports/
# 2. Sync
paperforge sync

# 3. Mark a paper for OCR in its frontmatter: do_ocr: true
# 4. Run OCR
paperforge ocr

# 5. Mark for deep reading: analyze: true
# 6. In your Agent chat:
/pf-deep <zotero_key>

Documentation

If you want to Read
Full tutorial, from install to deep read Getting Started
Troubleshooting Troubleshooting
Command reference Commands
How to update Update Guide
Architecture / Maintenance / Release Architecture
AI Agent collaboration AGENTS.md

License

CC BY-NC-SA 4.0. Non-commercial use only.

Acknowledgments

Built on PaddleOCR, Obsidian, Better BibTeX for Zotero, and other great open-source projects.