Skip to content

Add SCORM→JSON→DOCX pipeline and reorganize format/pipeline modules#18

Open
arolos wants to merge 8 commits into
mainfrom
14-scorm-to-docx
Open

Add SCORM→JSON→DOCX pipeline and reorganize format/pipeline modules#18
arolos wants to merge 8 commits into
mainfrom
14-scorm-to-docx

Conversation

@arolos

@arolos arolos commented Jan 27, 2026

Copy link
Copy Markdown
Member

Closes issue #14

  1. SCORM → JSON → DOCX conversion flow
  • Adds an end‑to‑end pipeline that takes SCORM packages, parses them into the existing JSON question model, and then renders DOCX from that JSON.
  • Handles conversion concerns like preserving question structure, formatting, and media so the DOCX output is usable without manual cleanup.
  1. API folder restructure
  • Moves legacy processing code out of generic buckets into format‑based modules:
    • api/formats/docx/* for DOCX parsing/formatting helpers.
    • api/formats/scorm/* for SCORM parsing/writing helpers.
    • api/formats/scorm/xml_builders/* for SCORM XML builders (per question type).
    • api/questions/model_builders/* for per‑question‑type model builders.
    • api/pipelines/* for explicit conversion entry points.
  1. Pipeline helpers + response payloads
  • Introduces api/pipelines/response_payload.py for consistent status/response payloads.
  • Adds api/pipelines/ws_pipeline.py for the WS progress pipeline.
  • Simplifies views/consumers by moving orchestration into pipelines.
  1. main_text support
  • Adds support for root‑level main content separate from the title.
  • That content is carried through the parse/serialize flow and included in the output alongside sections.
  1. Cleanup of legacy modules
  • Removes deprecated restapi/* and old api/process/* / api/scorm/* files.
  • Dockerfile no longer copies the deprecated restapi folder.

@arolos arolos requested a review from visoedhwa January 27, 2026 17:31
@arolos arolos self-assigned this Jan 27, 2026
@arolos arolos requested a review from kphunter as a code owner January 27, 2026 17:31
@arolos arolos added the waiting for feedback Needs feedback to continue label Jan 27, 2026
@arolos arolos linked an issue Jan 27, 2026 that may be closed by this pull request
@kphunter

kphunter commented Feb 3, 2026

Copy link
Copy Markdown
Contributor

I'm not sure how to verify/test these changes... (other than scanning the code manually 😳 )... Any thoughts?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

waiting for feedback Needs feedback to continue

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Implement SCORM to DOCX reverse conversion

2 participants