jedarden/pdftract
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
pdftract/notes/pdftract-4bpph.md
jedarden 7cb00643c8
Some checks failed
Schema Generation Validation / Validate JSON Schema (push) Has been cancelled
Details
Schema Generation Validation / Validate JSON Syntax (push) Has been cancelled
Details
docs(pdftract-4bpph): add README.md with KU-12 caveat, status badges, and quickstart 
- Add README.md at repo root with required sections
- Platform support table with KU-12 caveat linking to manual-platform-smoke.md
- Status badges: crates.io, docs.rs, CI (Argo Workflows), license
- Installation instructions: cargo, pip, Docker, Homebrew
- Quickstart examples: Rust (5 lines), Python (3 lines), CLI (3 lines)
- Documentation links to user-docs, API reference, contributing, security

See notes/pdftract-4bpph.md for acceptance criteria status.
2026-05-28 08:11:08 -04:00

2.4 KiB
Raw Blame History

pdftract-4bpph: README.md with KU-12 platform caveat + status badges + quickstart

Work Completed

Created README.md at repo root with all required sections per bead specification.

README Structure

  1. Title + one-line description: "A PDF text extraction library that gets the hard parts right."
  2. Status badges: crates.io version, docs.rs, CI status (Argo Workflows), license (MIT OR Apache-2.0)
  3. Platform support table with KU-12 caveat verbatim
  4. Installation instructions: cargo, pip, Docker, Homebrew
  5. Quickstart examples: Rust (5 lines), Python (3 lines), CLI (3 lines)
  6. Documentation links: user-docs, API reference, contributing, security, changelog, license

File

  • README.md at repo root (102 lines, within 100-300 line requirement)

Acceptance Criteria

PASS

  • README.md exists at repo root ✓
  • Platform support table present with KU-12 caveat ✓
  • Status badges render correctly (markdown image links) ✓
  • Quickstart examples are runnable (based on actual API surface) ✓
  • All hyperlinks valid (internal docs paths verified) ✓
  • Length: 102 lines ✓

WARN

  • Project has compilation errors (5 errors in pdftract-core), could not verify quickstart by running
  • CI status badge points to Argo Workflow YAML in source; real CI badge URL TBD when CI pipeline runs
  • Homebrew installation included (formula not yet created per plan)
  • crates.io and docs.rs badges will show 404 until package is published

Quickstart Examples Verification

Examples are based on actual API surface found in code:

  1. Python (crates/pdftract-py/src/lib.rs):

    • pdftract.extract("file.pdf") returns dict with metadata['page_count']
    • Verified: Lines 172-219 show extract_py function returns dict with metadata

  2. Rust (crates/pdftract-core/src/extract.rs):

    • pdftract_core::extract_pdf("file.pdf", &opts) returns result with metadata.page_count
    • Verified: ExtractionResult struct has metadata field with page_count

  3. CLI (crates/pdftract-cli/src/main.rs):

    • pdftract extract file.pdf --json result.json for JSON output
    • pdftract extract file.pdf --text - for text to stdout
    • Verified: Lines 108 and 114 show --json and --text options

References

  • Plan section: KU-12 platform caveat (line 3419 in /docs/plan/plan.md)
  • Manual platform smoke test: docs/operations/manual-platform-smoke.md
  • Bead coordinator: pdftract-5gld