Static scaffold.
\ No newline at end of file diff --git a/examples/review_output/promoted_pack/concepts.yaml b/examples/review_output/promoted_pack/concepts.yaml new file mode 100644 index 0000000..f4d3abe --- /dev/null +++ b/examples/review_output/promoted_pack/concepts.yaml @@ -0,0 +1,22 @@ +concepts: + - id: descriptive-statistics + title: Descriptive Statistics + description: Measures of center and spread. + prerequisites: [] + mastery_signals: + - Explain mean, median, and variance. + status: trusted + notes: + - Reviewed in initial curation pass. + mastery_profile: {} + + - id: probability-basics + title: Probability Basics + description: Basic event probability and conditional probability. + prerequisites: + - descriptive-statistics + mastery_signals: + - Compute a simple conditional probability. + status: provisional + notes: [] + mastery_profile: {} diff --git a/examples/review_output/promoted_pack/pack.yaml b/examples/review_output/promoted_pack/pack.yaml new file mode 100644 index 0000000..ae291c3 --- /dev/null +++ b/examples/review_output/promoted_pack/pack.yaml @@ -0,0 +1,6 @@ +name: introductory-bayesian-inference +display_name: Introductory Bayesian Inference +version: 0.1.0-reviewed +curation: + reviewer: Wesley R. Elsberry + ledger_entries: 2 diff --git a/examples/review_output/promoted_pack/review_ledger.json b/examples/review_output/promoted_pack/review_ledger.json new file mode 100644 index 0000000..8f1fc7b --- /dev/null +++ b/examples/review_output/promoted_pack/review_ledger.json @@ -0,0 +1,4 @@ +{ + "reviewer": "Wesley R. Elsberry", + "entries": 2 +} \ No newline at end of file diff --git a/examples/review_output/review_data.json b/examples/review_output/review_data.json new file mode 100644 index 0000000..1c81f9d --- /dev/null +++ b/examples/review_output/review_data.json @@ -0,0 +1,42 @@ +{ + "reviewer": "Wesley R. Elsberry", + "pack": { + "name": "introductory-bayesian-inference", + "version": "0.1.0-draft" + }, + "concepts": [ + { + "concept_id": "descriptive-statistics", + "title": "Descriptive Statistics", + "status": "trusted", + "prerequisites": [], + "description": "Measures of center and spread.", + "mastery_signals": [ + "Explain mean, median, and variance." + ], + "notes": [ + "Reviewed in initial curation pass." + ] + }, + { + "concept_id": "probability-basics", + "title": "Probability Basics", + "status": "provisional", + "prerequisites": [ + "descriptive-statistics" + ], + "description": "Basic event probability and conditional probability.", + "mastery_signals": [ + "Compute a simple conditional probability." + ], + "notes": [] + } + ], + "conflicts": [ + "Lesson 'prior and posterior' was merged from multiple sources; review ordering assumptions." + ], + "review_flags": [ + "Concept 'Prior and Posterior' may be too broad and may need splitting." + ], + "ledger": [] +} \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml index 8716c9e..d94ce90 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta" [project] name = "didactopus" version = "0.1.0" -description = "Didactopus: document-adapter and cross-course merger scaffold" +description = "Didactopus: draft-pack review workflow scaffold" readme = "README.md" requires-python = ">=3.10" license = {text = "MIT"} @@ -16,7 +16,7 @@ dependencies = ["pydantic>=2.7", "pyyaml>=6.0"] dev = ["pytest>=8.0", "ruff>=0.6"] [project.scripts] -didactopus-topic-ingest = "didactopus.main:main" +didactopus-review = "didactopus.main:main" [tool.setuptools.packages.find] where = ["src"] diff --git a/src/didactopus/config.py b/src/didactopus/config.py index 6dfcf72..01f66f7 100644 --- a/src/didactopus/config.py +++ b/src/didactopus/config.py @@ -3,33 +3,15 @@ from pydantic import BaseModel, Field import yaml -class DocumentAdaptersConfig(BaseModel): - allow_pdf: bool = True - allow_docx: bool = True - allow_pptx: bool = True - allow_html: bool = True - allow_markdown: bool = True - allow_text: bool = True - - -class CourseIngestConfig(BaseModel): - default_pack_author: str = "Unknown" - default_license: str = "REVIEW-REQUIRED" - min_term_length: int = 4 - max_terms_per_lesson: int = 8 - - -class CrossCourseConfig(BaseModel): - detect_title_overlaps: bool = True - detect_term_conflicts: bool = True - detect_order_conflicts: bool = True - merge_same_named_lessons: bool = True +class ReviewConfig(BaseModel): + default_reviewer: str = "Unknown Reviewer" + allow_provisional_concepts: bool = True + write_promoted_pack: bool = True + write_review_ledger: bool = True class AppConfig(BaseModel): - document_adapters: DocumentAdaptersConfig = Field(default_factory=DocumentAdaptersConfig) - course_ingest: CourseIngestConfig = Field(default_factory=CourseIngestConfig) - cross_course: CrossCourseConfig = Field(default_factory=CrossCourseConfig) + review: ReviewConfig = Field(default_factory=ReviewConfig) def load_config(path: str | Path) -> AppConfig: diff --git a/src/didactopus/main.py b/src/didactopus/main.py index 95a1076..cd0d5a9 100644 --- a/src/didactopus/main.py +++ b/src/didactopus/main.py @@ -4,69 +4,74 @@ import argparse from pathlib import Path from .config import load_config -from .document_adapters import adapt_document -from .topic_ingest import document_to_course, build_topic_bundle, merge_courses_into_topic_course, extract_concept_candidates -from .cross_course_conflicts import detect_title_overlaps, detect_term_conflicts, detect_order_conflicts, detect_thin_concepts -from .rule_policy import RuleContext, build_default_rules, run_rules -from .pack_emitter import build_draft_pack, write_draft_pack +from .review_loader import load_draft_pack +from .review_schema import ReviewSession, ReviewAction +from .review_actions import apply_action +from .review_export import export_review_state_json, export_promoted_pack, export_review_ui_data +from .ui_scaffold import write_review_ui def build_parser() -> argparse.ArgumentParser: - parser = argparse.ArgumentParser(description="Didactopus document-adapter and cross-course topic ingestion") - parser.add_argument("--inputs", nargs="+", required=True, help="Document inputs") - parser.add_argument("--title", required=True, help="Topic title") - parser.add_argument("--rights-note", default="REVIEW REQUIRED") - parser.add_argument("--output-dir", default="generated-topic-pack") + parser = argparse.ArgumentParser(description="Didactopus review workflow scaffold") + parser.add_argument("--draft-pack", required=True, help="Path to draft pack directory") + parser.add_argument("--output-dir", default="review-output") parser.add_argument("--config", default="configs/config.example.yaml") return parser def main() -> None: args = build_parser().parse_args() - config = load_config(args.config) + config = load_config(Path(args.config)) + draft = load_draft_pack(args.draft_pack) + session = ReviewSession(reviewer=config.review.default_reviewer, draft_pack=draft) - docs = [adapt_document(path) for path in args.inputs] - courses = [document_to_course(doc, course_title=args.title) for doc in docs] - topic = build_topic_bundle(args.title, courses) - merged_course = merge_courses_into_topic_course( - topic_bundle=topic, - merge_same_named_lessons=config.cross_course.merge_same_named_lessons, - ) - concepts = extract_concept_candidates(merged_course) + # Demo curation actions + if session.draft_pack.concepts: + first = session.draft_pack.concepts[0].concept_id + apply_action(session, session.reviewer, ReviewAction( + action_type="set_status", + target=first, + payload={"status": "trusted"}, + rationale="Initial concept appears well grounded.", + )) + apply_action(session, session.reviewer, ReviewAction( + action_type="note", + target=first, + payload={"note": "Reviewed in initial curation pass."}, + rationale="Record reviewer note.", + )) - context = RuleContext(course=merged_course, concepts=concepts) - rules = build_default_rules() - run_rules(context, rules) + if len(session.draft_pack.concepts) > 1: + second = session.draft_pack.concepts[1].concept_id + apply_action(session, session.reviewer, ReviewAction( + action_type="set_status", + target=second, + payload={"status": "provisional"}, + rationale="Keep provisional pending further review.", + )) - conflicts = [] - if config.cross_course.detect_title_overlaps: - conflicts.extend(detect_title_overlaps(merged_course)) - if config.cross_course.detect_term_conflicts: - conflicts.extend(detect_term_conflicts(merged_course)) - if config.cross_course.detect_order_conflicts: - conflicts.extend(detect_order_conflicts(merged_course)) - conflicts.extend(detect_thin_concepts(context.concepts)) + if session.draft_pack.conflicts: + apply_action(session, session.reviewer, ReviewAction( + action_type="resolve_conflict", + target="", + payload={"conflict": session.draft_pack.conflicts[0]}, + rationale="Resolved first conflict in demo workflow.", + )) - draft = build_draft_pack( - course=merged_course, - concepts=context.concepts, - author=config.course_ingest.default_pack_author, - license_name=config.course_ingest.default_license, - review_flags=context.review_flags, - conflicts=conflicts, - ) - write_draft_pack(draft, args.output_dir) + outdir = Path(args.output_dir) + outdir.mkdir(parents=True, exist_ok=True) - print("== Didactopus Cross-Course Topic Ingest ==") - print(f"Topic: {args.title}") - print(f"Documents: {len(docs)}") - print(f"Courses: {len(courses)}") - print(f"Merged modules: {len(merged_course.modules)}") - print(f"Concept candidates: {len(context.concepts)}") - print(f"Review flags: {len(context.review_flags)}") - print(f"Conflicts: {len(conflicts)}") - print(f"Output dir: {args.output_dir}") + export_review_state_json(session, outdir / "review_session.json") + export_review_ui_data(session, outdir) + write_review_ui(outdir) + if config.review.write_promoted_pack: + export_promoted_pack(session, outdir / "promoted_pack") -if __name__ == "__main__": - main() + print("== Didactopus Review Workflow ==") + print(f"Draft pack: {args.draft_pack}") + print(f"Reviewer: {session.reviewer}") + print(f"Concepts: {len(session.draft_pack.concepts)}") + print(f"Ledger entries: {len(session.ledger)}") + print(f"Remaining conflicts: {len(session.draft_pack.conflicts)}") + print(f"Output dir: {outdir}") diff --git a/src/didactopus/review_actions.py b/src/didactopus/review_actions.py new file mode 100644 index 0000000..692f16d --- /dev/null +++ b/src/didactopus/review_actions.py @@ -0,0 +1,50 @@ +from __future__ import annotations + +from .review_schema import ReviewAction, ReviewLedgerEntry, ReviewSession + + +def _find_concept(session: ReviewSession, concept_id: str): + for concept in session.draft_pack.concepts: + if concept.concept_id == concept_id: + return concept + return None + + +def apply_action(session: ReviewSession, reviewer: str, action: ReviewAction) -> None: + target = _find_concept(session, action.target) + + if action.action_type == "set_status" and target is not None: + target.status = action.payload.get("status", target.status) + elif action.action_type == "edit_prerequisites" and target is not None: + target.prerequisites = list(action.payload.get("prerequisites", target.prerequisites)) + elif action.action_type == "edit_title" and target is not None: + target.title = action.payload.get("title", target.title) + elif action.action_type == "edit_description" and target is not None: + target.description = action.payload.get("description", target.description) + elif action.action_type == "resolve_conflict": + text = action.payload.get("conflict", "") + if text in session.draft_pack.conflicts: + session.draft_pack.conflicts.remove(text) + elif action.action_type == "note" and target is not None: + note = action.payload.get("note", "") + if note: + target.notes.append(note) + elif action.action_type == "merge_concepts": + source = _find_concept(session, action.payload.get("source", "")) + dest = _find_concept(session, action.payload.get("destination", "")) + if source is not None and dest is not None and source is not dest: + for prereq in source.prerequisites: + if prereq not in dest.prerequisites: + dest.prerequisites.append(prereq) + for sig in source.mastery_signals: + if sig not in dest.mastery_signals: + dest.mastery_signals.append(sig) + for note in source.notes: + if note not in dest.notes: + dest.notes.append(note) + source.status = "rejected" + source.notes.append(f"Merged into {dest.concept_id}") + elif action.action_type == "split_concept" and target is not None: + target.notes.append("Split requested; manual follow-up required.") + + session.ledger.append(ReviewLedgerEntry(reviewer=reviewer, action=action)) diff --git a/src/didactopus/review_export.py b/src/didactopus/review_export.py new file mode 100644 index 0000000..873ca97 --- /dev/null +++ b/src/didactopus/review_export.py @@ -0,0 +1,57 @@ +from __future__ import annotations + +from pathlib import Path +import json +import yaml + +from .review_schema import ReviewSession + + +def export_review_state_json(session: ReviewSession, path: str | Path) -> None: + Path(path).write_text(session.model_dump_json(indent=2), encoding="utf-8") + + +def export_promoted_pack(session: ReviewSession, outdir: str | Path) -> None: + outdir = Path(outdir) + outdir.mkdir(parents=True, exist_ok=True) + + promoted_pack = dict(session.draft_pack.pack) + promoted_pack["version"] = str(promoted_pack.get("version", "0.1.0-draft")).replace("-draft", "-reviewed") + promoted_pack["curation"] = { + "reviewer": session.reviewer, + "ledger_entries": len(session.ledger), + } + + trusted_concepts = [] + for concept in session.draft_pack.concepts: + if concept.status == "rejected": + continue + trusted_concepts.append({ + "id": concept.concept_id, + "title": concept.title, + "description": concept.description, + "prerequisites": concept.prerequisites, + "mastery_signals": concept.mastery_signals, + "status": concept.status, + "notes": concept.notes, + "mastery_profile": {}, + }) + + (outdir / "pack.yaml").write_text(yaml.safe_dump(promoted_pack, sort_keys=False), encoding="utf-8") + (outdir / "concepts.yaml").write_text(yaml.safe_dump({"concepts": trusted_concepts}, sort_keys=False), encoding="utf-8") + (outdir / "review_ledger.json").write_text(json.dumps(session.model_dump(), indent=2), encoding="utf-8") + (outdir / "license_attribution.json").write_text(json.dumps(session.draft_pack.attribution, indent=2), encoding="utf-8") + + +def export_review_ui_data(session: ReviewSession, outdir: str | Path) -> None: + outdir = Path(outdir) + outdir.mkdir(parents=True, exist_ok=True) + data = { + "reviewer": session.reviewer, + "pack": session.draft_pack.pack, + "concepts": [c.model_dump() for c in session.draft_pack.concepts], + "conflicts": session.draft_pack.conflicts, + "review_flags": session.draft_pack.review_flags, + "ledger": [entry.model_dump() for entry in session.ledger], + } + (outdir / "review_data.json").write_text(json.dumps(data, indent=2), encoding="utf-8") diff --git a/src/didactopus/review_loader.py b/src/didactopus/review_loader.py new file mode 100644 index 0000000..8ca90da --- /dev/null +++ b/src/didactopus/review_loader.py @@ -0,0 +1,58 @@ +from __future__ import annotations + +from pathlib import Path +import json +import yaml + +from .review_schema import DraftPackData, ConceptReviewEntry + + +def load_draft_pack(pack_dir: str | Path) -> DraftPackData: + pack_dir = Path(pack_dir) + concepts_yaml = yaml.safe_load((pack_dir / "concepts.yaml").read_text(encoding="utf-8")) or {} + concepts = [] + for item in concepts_yaml.get("concepts", []): + concepts.append( + ConceptReviewEntry( + concept_id=item.get("id", ""), + title=item.get("title", ""), + description=item.get("description", ""), + prerequisites=list(item.get("prerequisites", [])), + mastery_signals=list(item.get("mastery_signals", [])), + ) + ) + + conflicts_path = pack_dir / "conflict_report.md" + review_path = pack_dir / "review_report.md" + attribution_path = pack_dir / "license_attribution.json" + pack_path = pack_dir / "pack.yaml" + + conflicts = [] + if conflicts_path.exists(): + conflicts = [ + line[2:] for line in conflicts_path.read_text(encoding="utf-8").splitlines() + if line.startswith("- ") + ] + + review_flags = [] + if review_path.exists(): + review_flags = [ + line[2:] for line in review_path.read_text(encoding="utf-8").splitlines() + if line.startswith("- ") + ] + + attribution = {} + if attribution_path.exists(): + attribution = json.loads(attribution_path.read_text(encoding="utf-8")) + + pack = {} + if pack_path.exists(): + pack = yaml.safe_load(pack_path.read_text(encoding="utf-8")) or {} + + return DraftPackData( + pack=pack, + concepts=concepts, + conflicts=conflicts, + review_flags=review_flags, + attribution=attribution, + ) diff --git a/src/didactopus/review_schema.py b/src/didactopus/review_schema.py new file mode 100644 index 0000000..ff82ccd --- /dev/null +++ b/src/didactopus/review_schema.py @@ -0,0 +1,52 @@ +from __future__ import annotations + +from pydantic import BaseModel, Field +from typing import Literal + +TrustStatus = Literal["trusted", "provisional", "rejected", "needs_review"] +ActionType = Literal[ + "set_status", + "edit_prerequisites", + "edit_title", + "edit_description", + "merge_concepts", + "split_concept", + "resolve_conflict", + "note", +] + + +class ConceptReviewEntry(BaseModel): + concept_id: str + title: str + description: str = "" + prerequisites: list[str] = Field(default_factory=list) + mastery_signals: list[str] = Field(default_factory=list) + status: TrustStatus = "needs_review" + notes: list[str] = Field(default_factory=list) + + +class ReviewAction(BaseModel): + action_type: ActionType + target: str + payload: dict = Field(default_factory=dict) + rationale: str = "" + + +class ReviewLedgerEntry(BaseModel): + reviewer: str + action: ReviewAction + + +class DraftPackData(BaseModel): + pack: dict = Field(default_factory=dict) + concepts: list[ConceptReviewEntry] = Field(default_factory=list) + conflicts: list[str] = Field(default_factory=list) + review_flags: list[str] = Field(default_factory=list) + attribution: dict = Field(default_factory=dict) + + +class ReviewSession(BaseModel): + reviewer: str + draft_pack: DraftPackData + ledger: list[ReviewLedgerEntry] = Field(default_factory=list) diff --git a/src/didactopus/ui_scaffold.py b/src/didactopus/ui_scaffold.py new file mode 100644 index 0000000..7e58105 --- /dev/null +++ b/src/didactopus/ui_scaffold.py @@ -0,0 +1,56 @@ +from __future__ import annotations + +from pathlib import Path + + +HTML = ''' + + + + +Static scaffold. Load review_data.json next to this file for future richer UI behavior.
review_data.jsonreview_ledger.jsonpack.yamlconcepts.yamlReplace this scaffold with a SPA that edits the same JSON review-state model.
+