diff --git a/bad-generated-pack/concepts.yaml b/bad-generated-pack/concepts.yaml index 679de99..979b6ed 100644 --- a/bad-generated-pack/concepts.yaml +++ b/bad-generated-pack/concepts.yaml @@ -3,23 +3,19 @@ concepts: title: Foundations description: Broad foundations topic with many ideas. prerequisites: [] - mastery_signals: - - Explain core foundations. - id: c2 title: Methods - description: Methods concept with sparse explicit assessment. + description: Methods concept. prerequisites: [c1] - mastery_signals: - - Use methods appropriately. - id: c3 title: Advanced Inference description: Advanced inference topic. prerequisites: [c1, c2] - mastery_signals: - - Critique advanced inference. - id: c4 title: Detached Topic description: Detached topic with no assessment coverage. prerequisites: [] - mastery_signals: - - Explain detached topic. + - id: c5 + title: Capstone Topic + description: Final synthesis topic. + prerequisites: [c3] diff --git a/bad-generated-pack/projects.yaml b/bad-generated-pack/projects.yaml index c3b5cc5..4bbefa2 100644 --- a/bad-generated-pack/projects.yaml +++ b/bad-generated-pack/projects.yaml @@ -1,6 +1,6 @@ projects: - - id: narrow-project - title: Final Memo + - id: early-capstone + title: Capstone Final Project prerequisites: [c1] deliverables: - - brief memo + - short memo diff --git a/bad-generated-pack/roadmap.yaml b/bad-generated-pack/roadmap.yaml index 8c0549c..d883c88 100644 --- a/bad-generated-pack/roadmap.yaml +++ b/bad-generated-pack/roadmap.yaml @@ -7,3 +7,7 @@ stages: title: Tiny Bridge concepts: [c4] checkpoint: [] + - id: stage-3 + title: Ending + concepts: [c5] + checkpoint: [] diff --git a/bad-generated-pack/rubrics.yaml b/bad-generated-pack/rubrics.yaml index 4411647..022833d 100644 --- a/bad-generated-pack/rubrics.yaml +++ b/bad-generated-pack/rubrics.yaml @@ -1,4 +1,4 @@ rubrics: - id: r1 title: Basic - criteria: [style, formatting] + criteria: [correctness] diff --git a/configs/config.example.yaml b/configs/config.example.yaml index 7ffd008..9c20d36 100644 --- a/configs/config.example.yaml +++ b/configs/config.example.yaml @@ -1,5 +1,6 @@ review: default_reviewer: "Wesley R. Elsberry" + write_promoted_pack: true bridge: host: "127.0.0.1" port: 8765 diff --git a/docs/faq.md b/docs/faq.md index 501991c..aecd8ae 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -1,3 +1,9 @@ # FAQ -This layer does not prove pedagogical adequacy. It is a heuristic signal layer for likely misalignments. +## Why add curriculum path quality? + +Because even a good concept graph does not automatically produce a good learning path. + +## Does this replace human pedagogical judgment? + +No. It is a heuristic review aid meant to reduce preventable friction. diff --git a/generated-pack/concepts.yaml b/generated-pack/concepts.yaml index 923187d..850eb6a 100644 --- a/generated-pack/concepts.yaml +++ b/generated-pack/concepts.yaml @@ -3,17 +3,11 @@ concepts: title: Bayes Prior description: Prior beliefs before evidence in a probabilistic model. prerequisites: [] - mastery_signals: - - Explain a prior distribution clearly. - id: bayes-posterior title: Bayes Posterior description: Updated beliefs after evidence in a probabilistic model. prerequisites: [bayes-prior] - mastery_signals: - - Compare prior and posterior beliefs. - id: model-checking title: Model Checking description: Evaluate whether model assumptions and fit remain plausible. prerequisites: [bayes-posterior] - mastery_signals: - - Critique a model fit. diff --git a/generated-pack/projects.yaml b/generated-pack/projects.yaml index 82a48bb..2a2eab2 100644 --- a/generated-pack/projects.yaml +++ b/generated-pack/projects.yaml @@ -3,5 +3,4 @@ projects: title: Final Model Critique prerequisites: [bayes-prior, bayes-posterior, model-checking] deliverables: - - short critique report - - explanation of prior and posterior updates + - short report diff --git a/generated-pack/rubrics.yaml b/generated-pack/rubrics.yaml index b15545a..cd4006e 100644 --- a/generated-pack/rubrics.yaml +++ b/generated-pack/rubrics.yaml @@ -1,4 +1,4 @@ rubrics: - id: r1 title: Basic - criteria: [correctness, explanation, critique] + criteria: [correctness, explanation] diff --git a/pyproject.toml b/pyproject.toml index 6ae47ef..9fa98c7 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -5,13 +5,15 @@ build-backend = "setuptools.build_meta" [project] name = "didactopus" version = "0.1.0" -description = "Didactopus: coverage and alignment analysis" +description = "Didactopus: curriculum path quality analysis" readme = "README.md" requires-python = ">=3.10" +license = {text = "MIT"} +authors = [{name = "Wesley R. Elsberry"}] dependencies = ["pydantic>=2.7", "pyyaml>=6.0"] [project.optional-dependencies] -dev = ["pytest>=8.0"] +dev = ["pytest>=8.0", "ruff>=0.6"] [project.scripts] didactopus-review-bridge = "didactopus.review_bridge_server:main" diff --git a/src/didactopus/__init__.py b/src/didactopus/__init__.py index b794fd4..3dc1f76 100644 --- a/src/didactopus/__init__.py +++ b/src/didactopus/__init__.py @@ -1 +1 @@ -__version__ = '0.1.0' +__version__ = "0.1.0" diff --git a/src/didactopus/config.py b/src/didactopus/config.py index ec8a18e..77b988d 100644 --- a/src/didactopus/config.py +++ b/src/didactopus/config.py @@ -4,6 +4,7 @@ import yaml class ReviewConfig(BaseModel): default_reviewer: str = "Unknown Reviewer" + write_promoted_pack: bool = True class BridgeConfig(BaseModel): host: str = "127.0.0.1" @@ -17,4 +18,5 @@ class AppConfig(BaseModel): def load_config(path: str | Path) -> AppConfig: with open(path, "r", encoding="utf-8") as handle: - return AppConfig.model_validate(yaml.safe_load(handle) or {}) + data = yaml.safe_load(handle) or {} + return AppConfig.model_validate(data) diff --git a/src/didactopus/graph_qa.py b/src/didactopus/graph_qa.py index f2e0958..22b260e 100644 --- a/src/didactopus/graph_qa.py +++ b/src/didactopus/graph_qa.py @@ -1,4 +1,51 @@ +from __future__ import annotations +from collections import defaultdict, deque from .pack_validator import load_pack_artifacts -def graph_qa_for_pack(source_dir): + +def graph_qa_for_pack(source_dir) -> dict: loaded = load_pack_artifacts(source_dir) - return {"warnings": [], "summary": {"graph_warning_count": 0}} if loaded["ok"] else {"warnings": [], "summary": {"graph_warning_count": 0}} + if not loaded["ok"]: + return {"warnings": [], "summary": {"graph_warning_count": 0}} + concepts = loaded["artifacts"]["concepts"].get("concepts", []) or [] + concept_ids = [c.get("id") for c in concepts if c.get("id")] + prereqs = {c.get("id"): list(c.get("prerequisites", []) or []) for c in concepts if c.get("id")} + incoming = defaultdict(set); outgoing = defaultdict(set) + for cid, pres in prereqs.items(): + for p in pres: + outgoing[p].add(cid); incoming[cid].add(p) + warnings = [] + WHITE, GRAY, BLACK = 0, 1, 2 + color = {cid: WHITE for cid in concept_ids}; stack = []; found_cycles = [] + def dfs(node): + color[node] = GRAY; stack.append(node) + for nxt in outgoing.get(node, []): + if color.get(nxt, WHITE) == WHITE: dfs(nxt) + elif color.get(nxt) == GRAY and nxt in stack: + idx = stack.index(nxt); found_cycles.append(stack[idx:] + [nxt]) + stack.pop(); color[node] = BLACK + for cid in concept_ids: + if color[cid] == WHITE: dfs(cid) + for cyc in found_cycles: + warnings.append("Prerequisite cycle detected: " + " -> ".join(cyc)) + for cid in concept_ids: + if len(incoming[cid]) == 0 and len(outgoing[cid]) == 0: + warnings.append(f"Concept '{cid}' is isolated from the prerequisite graph.") + for cid in concept_ids: + if len(outgoing[cid]) >= 3: + warnings.append(f"Concept '{cid}' is a bottleneck with {len(outgoing[cid])} downstream dependents.") + edge_count = sum(len(v) for v in prereqs.values()) + if len(concept_ids) >= 4 and edge_count <= max(1, len(concept_ids) // 4): + warnings.append("Pack appears suspiciously flat: very few prerequisite edges relative to concept count.") + indegree = {cid: len(incoming[cid]) for cid in concept_ids} + q = deque([cid for cid in concept_ids if indegree[cid] == 0]); longest = {cid: 1 for cid in concept_ids} + while q: + node = q.popleft() + for nxt in outgoing.get(node, []): + longest[nxt] = max(longest.get(nxt, 1), longest[node] + 1) + indegree[nxt] -= 1 + if indegree[nxt] == 0: q.append(nxt) + max_chain = max(longest.values()) if longest else 0 + if max_chain >= 6: + warnings.append(f"Pack has a deep prerequisite chain of length {max_chain}, which may indicate over-fragmentation.") + summary = {"graph_warning_count": len(warnings), "concept_count": len(concept_ids), "edge_count": edge_count, "max_chain_length": max_chain} + return {"warnings": warnings, "summary": summary} diff --git a/src/didactopus/import_validator.py b/src/didactopus/import_validator.py index 5c30fb7..056a8c3 100644 --- a/src/didactopus/import_validator.py +++ b/src/didactopus/import_validator.py @@ -1,17 +1,16 @@ +from __future__ import annotations from pathlib import Path from .review_schema import ImportPreview from .pack_validator import validate_pack_directory from .semantic_qa import semantic_qa_for_pack from .graph_qa import graph_qa_for_pack from .path_quality_qa import path_quality_for_pack -from .coverage_alignment_qa import coverage_alignment_for_pack -def preview_draft_pack_import(source_dir, workspace_id, overwrite_required=False): +def preview_draft_pack_import(source_dir: str | Path, workspace_id: str, overwrite_required: bool = False) -> ImportPreview: result = validate_pack_directory(source_dir) semantic = semantic_qa_for_pack(source_dir) if result["ok"] else {"warnings": []} graph = graph_qa_for_pack(source_dir) if result["ok"] else {"warnings": []} pathq = path_quality_for_pack(source_dir) if result["ok"] else {"warnings": []} - coverage = coverage_alignment_for_pack(source_dir) if result["ok"] else {"warnings": []} return ImportPreview( source_dir=str(Path(source_dir)), workspace_id=workspace_id, @@ -23,5 +22,4 @@ def preview_draft_pack_import(source_dir, workspace_id, overwrite_required=False semantic_warnings=list(semantic["warnings"]), graph_warnings=list(graph["warnings"]), path_warnings=list(pathq["warnings"]), - coverage_warnings=list(coverage["warnings"]), ) diff --git a/src/didactopus/pack_validator.py b/src/didactopus/pack_validator.py index 84d8c82..a90866d 100644 --- a/src/didactopus/pack_validator.py +++ b/src/didactopus/pack_validator.py @@ -1,7 +1,8 @@ +from __future__ import annotations from pathlib import Path import yaml -REQUIRED_FILES = ["pack.yaml","concepts.yaml","roadmap.yaml","projects.yaml","rubrics.yaml"] +REQUIRED_FILES = ["pack.yaml", "concepts.yaml", "roadmap.yaml", "projects.yaml", "rubrics.yaml"] def _safe_load_yaml(path: Path, errors: list[str], label: str): try: @@ -10,73 +11,90 @@ def _safe_load_yaml(path: Path, errors: list[str], label: str): errors.append(f"Could not parse {label}: {exc}") return {} -def load_pack_artifacts(source_dir): +def load_pack_artifacts(source_dir: str | Path) -> dict: source = Path(source_dir) - errors = [] + errors: list[str] = [] if not source.exists(): return {"ok": False, "errors": [f"Source directory does not exist: {source}"], "warnings": [], "summary": {}, "artifacts": {}} if not source.is_dir(): return {"ok": False, "errors": [f"Source path is not a directory: {source}"], "warnings": [], "summary": {}, "artifacts": {}} - for fn in REQUIRED_FILES: - if not (source/fn).exists(): - errors.append(f"Missing required file: {fn}") + for filename in REQUIRED_FILES: + if not (source / filename).exists(): + errors.append(f"Missing required file: {filename}") if errors: return {"ok": False, "errors": errors, "warnings": [], "summary": {}, "artifacts": {}} - return { - "ok": True, "errors": [], "warnings": [], "summary": {}, - "artifacts": { - "pack": _safe_load_yaml(source/"pack.yaml", errors, "pack.yaml"), - "concepts": _safe_load_yaml(source/"concepts.yaml", errors, "concepts.yaml"), - "roadmap": _safe_load_yaml(source/"roadmap.yaml", errors, "roadmap.yaml"), - "projects": _safe_load_yaml(source/"projects.yaml", errors, "projects.yaml"), - "rubrics": _safe_load_yaml(source/"rubrics.yaml", errors, "rubrics.yaml"), - } - } + pack_data = _safe_load_yaml(source / "pack.yaml", errors, "pack.yaml") + concepts_data = _safe_load_yaml(source / "concepts.yaml", errors, "concepts.yaml") + roadmap_data = _safe_load_yaml(source / "roadmap.yaml", errors, "roadmap.yaml") + projects_data = _safe_load_yaml(source / "projects.yaml", errors, "projects.yaml") + rubrics_data = _safe_load_yaml(source / "rubrics.yaml", errors, "rubrics.yaml") + return {"ok": len(errors) == 0, "errors": errors, "warnings": [], "summary": {}, "artifacts": {"pack": pack_data, "concepts": concepts_data, "roadmap": roadmap_data, "projects": projects_data, "rubrics": rubrics_data}} -def validate_pack_directory(source_dir): +def validate_pack_directory(source_dir: str | Path) -> dict: loaded = load_pack_artifacts(source_dir) - errors = list(loaded["errors"]); warnings = list(loaded["warnings"]); summary = dict(loaded["summary"]) + errors = list(loaded["errors"]) + warnings = list(loaded["warnings"]) + summary = dict(loaded["summary"]) if not loaded["ok"]: return {"ok": False, "errors": errors, "warnings": warnings, "summary": summary} - pack = loaded["artifacts"]["pack"]; concepts = loaded["artifacts"]["concepts"].get("concepts", []) or [] - roadmap = loaded["artifacts"]["roadmap"].get("stages", []) or [] - projects = loaded["artifacts"]["projects"].get("projects", []) or [] - rubrics = loaded["artifacts"]["rubrics"].get("rubrics", []) or [] - for field in ["name","display_name","version"]: - if field not in pack: + pack_data = loaded["artifacts"]["pack"] + concepts_data = loaded["artifacts"]["concepts"] + roadmap_data = loaded["artifacts"]["roadmap"] + projects_data = loaded["artifacts"]["projects"] + rubrics_data = loaded["artifacts"]["rubrics"] + for field in ["name", "display_name", "version"]: + if field not in pack_data: warnings.append(f"pack.yaml has no '{field}' field.") - ids = [] - for i, c in enumerate(concepts): - cid = c.get("id","") + concepts = concepts_data.get("concepts", []) + roadmap_stages = roadmap_data.get("stages", []) + projects = projects_data.get("projects", []) + rubrics = rubrics_data.get("rubrics", []) + if not isinstance(concepts, list): + errors.append("concepts.yaml top-level 'concepts' is not a list."); concepts = [] + if not isinstance(roadmap_stages, list): + errors.append("roadmap.yaml top-level 'stages' is not a list."); roadmap_stages = [] + if not isinstance(projects, list): + errors.append("projects.yaml top-level 'projects' is not a list."); projects = [] + if not isinstance(rubrics, list): + errors.append("rubrics.yaml top-level 'rubrics' is not a list."); rubrics = [] + concept_ids = [] + for idx, concept in enumerate(concepts): + cid = concept.get("id", "") if not cid: - errors.append(f"Concept at index {i} has no id.") + errors.append(f"Concept at index {idx} has no id.") else: - ids.append(cid) - if len(str(c.get("description","")).strip()) < 12: - warnings.append(f"Concept '{cid or i}' has a very thin description.") - seen = set() - for cid in ids: - if cid in seen: - errors.append(f"Duplicate concept id: {cid}") + concept_ids.append(cid) + if not concept.get("title"): + warnings.append(f"Concept '{cid or idx}' has no title.") + desc = str(concept.get("description", "") or "") + if len(desc.strip()) < 12: + warnings.append(f"Concept '{cid or idx}' has a very thin description.") + seen = set(); dups = set() + for cid in concept_ids: + if cid in seen: dups.add(cid) seen.add(cid) - idset = set(ids) - for stage in roadmap: + for cid in sorted(dups): + errors.append(f"Duplicate concept id: {cid}") + concept_id_set = set(concept_ids) + for stage in roadmap_stages: for cid in stage.get("concepts", []) or []: - if cid not in idset: + if cid not in concept_id_set: errors.append(f"roadmap.yaml references missing concept id: {cid}") for project in projects: + if not project.get("id"): + warnings.append("A project entry has no id.") for cid in project.get("prerequisites", []) or []: - if cid not in idset: + if cid not in concept_id_set: errors.append(f"projects.yaml references missing prerequisite concept id: {cid}") - for i, rubric in enumerate(rubrics): - crit = rubric.get("criteria", []) + for idx, rubric in enumerate(rubrics): if not rubric.get("id"): - warnings.append(f"Rubric at index {i} has no id.") - if crit is None: - warnings.append(f"Rubric '{rubric.get('id', i)}' has null criteria.") - elif isinstance(crit, list) and len(crit) == 0: - warnings.append(f"Rubric '{rubric.get('id', i)}' has empty criteria.") - elif not isinstance(crit, list): - errors.append(f"Rubric '{rubric.get('id', i)}' criteria is not a list.") - summary = {"pack_name": pack.get("name",""), "display_name": pack.get("display_name",""), "version": pack.get("version",""), "concept_count": len(concepts), "roadmap_stage_count": len(roadmap), "project_count": len(projects), "rubric_count": len(rubrics)} - return {"ok": len(errors)==0, "errors": errors, "warnings": warnings, "summary": summary} + warnings.append(f"Rubric at index {idx} has no id.") + criteria = rubric.get("criteria", []) + if criteria is None: + warnings.append(f"Rubric '{rubric.get('id', idx)}' has null criteria.") + elif isinstance(criteria, list) and len(criteria) == 0: + warnings.append(f"Rubric '{rubric.get('id', idx)}' has empty criteria.") + elif not isinstance(criteria, list): + errors.append(f"Rubric '{rubric.get('id', idx)}' criteria is not a list.") + summary = {"pack_name": pack_data.get("name", ""), "display_name": pack_data.get("display_name", ""), "version": pack_data.get("version", ""), "concept_count": len(concepts), "roadmap_stage_count": len(roadmap_stages), "project_count": len(projects), "rubric_count": len(rubrics), "error_count": len(errors), "warning_count": len(warnings)} + return {"ok": len(errors) == 0, "errors": errors, "warnings": warnings, "summary": summary} diff --git a/src/didactopus/path_quality_qa.py b/src/didactopus/path_quality_qa.py index efb0a7d..0ef5521 100644 --- a/src/didactopus/path_quality_qa.py +++ b/src/didactopus/path_quality_qa.py @@ -1,13 +1,14 @@ +from __future__ import annotations import re from statistics import mean from .pack_validator import load_pack_artifacts -CAPSTONE_HINTS = {"capstone","final","comprehensive","culminating"} +CAPSTONE_HINTS = {"capstone", "final", "comprehensive", "culminating"} def tokenize(text: str) -> set[str]: - return {t for t in re.sub(r"[^a-z0-9]+", " ", str(text).lower()).split() if t} + return {t for t in re.sub(r"[^a-z0-9]+", " ", text.lower()).split() if t} -def path_quality_for_pack(source_dir): +def path_quality_for_pack(source_dir) -> dict: loaded = load_pack_artifacts(source_dir) if not loaded["ok"]: return {"warnings": [], "summary": {"path_warning_count": 0}} @@ -15,36 +16,49 @@ def path_quality_for_pack(source_dir): roadmap = loaded["artifacts"]["roadmap"].get("stages", []) or [] projects = loaded["artifacts"]["projects"].get("projects", []) or [] concept_by_id = {c.get("id"): c for c in concepts if c.get("id")} - project_prereq_ids = {cid for p in projects for cid in (p.get("prerequisites", []) or [])} - warnings = []; stage_sizes = []; stage_prereq_loads = []; assessed = set(project_prereq_ids) + project_prereq_ids = set() + for p in projects: + for cid in p.get("prerequisites", []) or []: + project_prereq_ids.add(cid) + warnings = [] + stage_sizes = []; stage_prereq_loads = []; assessed_ids = set(project_prereq_ids) for idx, stage in enumerate(roadmap): - sc = stage.get("concepts", []) or []; cp = stage.get("checkpoint", []) or [] - stage_sizes.append(len(sc)) - if len(sc) == 0: warnings.append(f"Roadmap stage '{stage.get('title', idx)}' has no concepts.") - if len(cp) == 0: warnings.append(f"Roadmap stage '{stage.get('title', idx)}' has no checkpoint activity.") - cp_tokens = tokenize(' '.join(str(x) for x in cp)) - for cid in sc: - if tokenize(concept_by_id.get(cid, {}).get("title","")) & cp_tokens: - assessed.add(cid) - stage_prereq_loads.append(sum(len(concept_by_id.get(cid, {}).get("prerequisites", []) or []) for cid in sc)) + stage_concepts = stage.get("concepts", []) or [] + checkpoints = stage.get("checkpoint", []) or [] + stage_sizes.append(len(stage_concepts)) + if len(stage_concepts) == 0: + warnings.append(f"Roadmap stage '{stage.get('title', idx)}' has no concepts.") + if len(checkpoints) == 0: + warnings.append(f"Roadmap stage '{stage.get('title', idx)}' has no checkpoint activity.") + cp_tokens = tokenize(' '.join(str(x) for x in checkpoints)) + for cid in stage_concepts: + title_tokens = tokenize(concept_by_id.get(cid, {}).get("title", "")) + if title_tokens and (title_tokens & cp_tokens): + assessed_ids.add(cid) + stage_prereq_loads.append(sum(len(concept_by_id.get(cid, {}).get("prerequisites", []) or []) for cid in stage_concepts)) for cid in concept_by_id: - if cid not in assessed: warnings.append(f"Concept '{cid}' is not visibly assessed by checkpoints or project prerequisites.") + if cid not in assessed_ids: + warnings.append(f"Concept '{cid}' is not visibly assessed by checkpoints or project prerequisites.") for idx, project in enumerate(projects): - if tokenize(project.get("title","")) & CAPSTONE_HINTS and len(roadmap) >= 3 and idx == 0: + if tokenize(project.get("title", "")) & CAPSTONE_HINTS and len(roadmap) >= 3 and idx == 0: warnings.append(f"Project '{project.get('title')}' looks capstone-like but appears very early in the project list.") if roadmap: - for idx in range(max(0, len(roadmap)-2), len(roadmap)): - stage = roadmap[idx]; sc = stage.get("concepts", []) or []; cp = stage.get("checkpoint", []) or [] - linked = any(cid in project_prereq_ids for cid in sc) - if sc and len(cp) == 0 and not linked: + late_start = max(0, len(roadmap) - 2) + for idx in range(late_start, len(roadmap)): + stage = roadmap[idx]; stage_concepts = stage.get("concepts", []) or []; checkpoints = stage.get("checkpoint", []) or [] + linked_to_project = any(cid in project_prereq_ids for cid in stage_concepts) + if stage_concepts and len(checkpoints) == 0 and not linked_to_project: warnings.append(f"Late roadmap stage '{stage.get('title', idx)}' may be a dead end: no checkpoints and no project linkage.") if stage_sizes: - avg = mean(stage_sizes) + avg_size = mean(stage_sizes) for idx, size in enumerate(stage_sizes): title = roadmap[idx].get("title", idx) - if avg > 0 and size >= max(4, 2.5 * avg): warnings.append(f"Roadmap stage '{title}' is unusually large relative to other stages.") - if len(roadmap) >= 3 and size == 1: warnings.append(f"Roadmap stage '{title}' is unusually small and may need merging or support concepts.") + if avg_size > 0 and size >= max(4, 2.5 * avg_size): + warnings.append(f"Roadmap stage '{title}' is unusually large relative to other stages.") + if len(roadmap) >= 3 and size == 1: + warnings.append(f"Roadmap stage '{title}' is unusually small and may need merging or support concepts.") for idx in range(1, len(stage_prereq_loads)): - if stage_prereq_loads[idx] >= stage_prereq_loads[idx-1] + 3: + if stage_prereq_loads[idx] >= stage_prereq_loads[idx - 1] + 3: warnings.append(f"Roadmap stage '{roadmap[idx].get('title', idx)}' shows an abrupt prerequisite-load jump from the prior stage.") - return {"warnings": warnings, "summary": {"path_warning_count": len(warnings)}} + summary = {"path_warning_count": len(warnings), "stage_count": len(roadmap), "project_count": len(projects), "unassessed_concept_count": sum(1 for cid in concept_by_id if cid not in assessed_ids)} + return {"warnings": warnings, "summary": summary} diff --git a/src/didactopus/review_actions.py b/src/didactopus/review_actions.py index 37aaa4e..0910084 100644 --- a/src/didactopus/review_actions.py +++ b/src/didactopus/review_actions.py @@ -1,3 +1,4 @@ +from __future__ import annotations from .review_schema import ReviewAction, ReviewLedgerEntry, ReviewSession def _find_concept(session: ReviewSession, concept_id: str): diff --git a/src/didactopus/review_bridge.py b/src/didactopus/review_bridge.py index 9f7949d..ca3adca 100644 --- a/src/didactopus/review_bridge.py +++ b/src/didactopus/review_bridge.py @@ -1,3 +1,4 @@ +from __future__ import annotations from pathlib import Path import json from .review_loader import load_draft_pack @@ -6,36 +7,27 @@ from .review_actions import apply_action from .review_export import export_review_state_json, export_promoted_pack class ReviewWorkspaceBridge: - def __init__(self, workspace_dir, reviewer="Unknown Reviewer"): - self.workspace_dir = Path(workspace_dir) - self.reviewer = reviewer - self.workspace_dir.mkdir(parents=True, exist_ok=True) - + def __init__(self, workspace_dir: str | Path, reviewer: str = "Unknown Reviewer") -> None: + self.workspace_dir = Path(workspace_dir); self.reviewer = reviewer; self.workspace_dir.mkdir(parents=True, exist_ok=True) @property - def draft_pack_dir(self): return self.workspace_dir / "draft_pack" + def draft_pack_dir(self) -> Path: return self.workspace_dir / "draft_pack" @property - def review_session_path(self): return self.workspace_dir / "review_session.json" + def review_session_path(self) -> Path: return self.workspace_dir / "review_session.json" @property - def promoted_pack_dir(self): return self.workspace_dir / "promoted_pack" - - def load_session(self): + def promoted_pack_dir(self) -> Path: return self.workspace_dir / "promoted_pack" + def load_session(self) -> ReviewSession: if self.review_session_path.exists(): return ReviewSession.model_validate(json.loads(self.review_session_path.read_text(encoding="utf-8"))) draft = load_draft_pack(self.draft_pack_dir) session = ReviewSession(reviewer=self.reviewer, draft_pack=draft) export_review_state_json(session, self.review_session_path) return session - - def save_session(self, session): export_review_state_json(session, self.review_session_path) - - def apply_actions(self, actions): + def save_session(self, session: ReviewSession) -> None: + export_review_state_json(session, self.review_session_path) + def apply_actions(self, actions: list[dict]) -> ReviewSession: session = self.load_session() for action_dict in actions: apply_action(session, session.reviewer, ReviewAction.model_validate(action_dict)) - self.save_session(session) - return session - - def export_promoted(self): - session = self.load_session() - export_promoted_pack(session, self.promoted_pack_dir) - return session + self.save_session(session); return session + def export_promoted(self) -> ReviewSession: + session = self.load_session(); export_promoted_pack(session, self.promoted_pack_dir); return session diff --git a/src/didactopus/review_bridge_server.py b/src/didactopus/review_bridge_server.py index 53c0a07..72d09d9 100644 --- a/src/didactopus/review_bridge_server.py +++ b/src/didactopus/review_bridge_server.py @@ -1,3 +1,4 @@ +from __future__ import annotations import argparse, json from http.server import BaseHTTPRequestHandler, HTTPServer from pathlib import Path @@ -5,7 +6,7 @@ from .config import load_config from .review_bridge import ReviewWorkspaceBridge from .workspace_manager import WorkspaceManager -def json_response(handler, status, payload): +def json_response(handler: BaseHTTPRequestHandler, status: int, payload: dict) -> None: body = json.dumps(payload, indent=2).encode("utf-8") handler.send_response(status) handler.send_header("Content-Type", "application/json") @@ -17,13 +18,13 @@ def json_response(handler, status, payload): handler.wfile.write(body) class ReviewBridgeHandler(BaseHTTPRequestHandler): - reviewer = "Unknown Reviewer" - workspace_manager = None - active_bridge = None - active_workspace_id = None + reviewer: str = "Unknown Reviewer" + workspace_manager: WorkspaceManager = None # type: ignore + active_bridge: ReviewWorkspaceBridge | None = None + active_workspace_id: str | None = None @classmethod - def set_active_workspace(cls, workspace_id): + def set_active_workspace(cls, workspace_id: str) -> bool: meta = cls.workspace_manager.touch_recent(workspace_id) if meta is None: return False cls.active_workspace_id = workspace_id @@ -34,7 +35,7 @@ class ReviewBridgeHandler(BaseHTTPRequestHandler): def do_GET(self): if self.path == "/api/workspaces": - return json_response(self, 200, self.workspace_manager.list_workspaces().model_dump()) + return json_response(self, 200, ReviewBridgeHandler.workspace_manager.list_workspaces().model_dump()) if self.path == "/api/load": if self.active_bridge is None: return json_response(self, 400, {"error": "no active workspace"}) return json_response(self, 200, {"workspace_id": self.active_workspace_id, "session": self.active_bridge.load_session().model_dump()}) @@ -45,16 +46,16 @@ class ReviewBridgeHandler(BaseHTTPRequestHandler): payload = json.loads((self.rfile.read(length) if length else b"{}").decode("utf-8") or "{}") if self.path == "/api/workspaces/create": meta = self.workspace_manager.create_workspace(payload["workspace_id"], payload["title"], notes=payload.get("notes", "")) - self.set_active_workspace(meta.workspace_id) - return json_response(self, 200, {"ok": True, "workspace": meta.model_dump()}) + self.set_active_workspace(meta.workspace_id); return json_response(self, 200, {"ok": True, "workspace": meta.model_dump()}) if self.path == "/api/workspaces/open": ok = self.set_active_workspace(payload["workspace_id"]) return json_response(self, 200 if ok else 404, {"ok": ok, "workspace_id": self.active_workspace_id} if ok else {"error": "workspace not found"}) if self.path == "/api/workspaces/import-preview": - return json_response(self, 200, self.workspace_manager.preview_import(payload["source_dir"], payload["workspace_id"]).model_dump()) + preview = self.workspace_manager.preview_import(payload["source_dir"], payload["workspace_id"]) + return json_response(self, 200, preview.model_dump()) if self.path == "/api/workspaces/import": try: - meta = self.workspace_manager.import_draft_pack(payload["source_dir"], payload["workspace_id"], title=payload.get("title"), notes=payload.get("notes",""), allow_overwrite=bool(payload.get("allow_overwrite", False))) + meta = self.workspace_manager.import_draft_pack(payload["source_dir"], payload["workspace_id"], title=payload.get("title"), notes=payload.get("notes", ""), allow_overwrite=bool(payload.get("allow_overwrite", False))) except FileNotFoundError as exc: return json_response(self, 404, {"ok": False, "error": str(exc)}) except FileExistsError as exc: @@ -72,12 +73,12 @@ class ReviewBridgeHandler(BaseHTTPRequestHandler): return json_response(self, 200, {"ok": True, "promoted_pack_dir": str(self.active_bridge.promoted_pack_dir), "workspace_id": self.active_workspace_id, "session": session.model_dump()}) return json_response(self, 404, {"error": "not found"}) -def build_parser(): - p = argparse.ArgumentParser(description="Didactopus local review bridge server with coverage/alignment QA") - p.add_argument("--config", default="configs/config.example.yaml") - return p +def build_parser() -> argparse.ArgumentParser: + parser = argparse.ArgumentParser(description="Didactopus local review bridge server with curriculum path quality QA") + parser.add_argument("--config", default="configs/config.example.yaml") + return parser -def main(): +def main() -> None: args = build_parser().parse_args() config = load_config(Path(args.config)) ReviewBridgeHandler.reviewer = config.review.default_reviewer @@ -85,6 +86,3 @@ def main(): server = HTTPServer((config.bridge.host, config.bridge.port), ReviewBridgeHandler) print(f"Didactopus review bridge listening on http://{config.bridge.host}:{config.bridge.port}") server.serve_forever() - -if __name__ == "__main__": - main() diff --git a/src/didactopus/review_export.py b/src/didactopus/review_export.py index 407cabd..9ffafdc 100644 --- a/src/didactopus/review_export.py +++ b/src/didactopus/review_export.py @@ -1,24 +1,34 @@ +from __future__ import annotations from pathlib import Path import json, yaml from .review_schema import ReviewSession -def export_review_state_json(session: ReviewSession, path): +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): - outdir = Path(outdir); outdir.mkdir(parents=True, exist_ok=True) - promoted = dict(session.draft_pack.pack) - promoted["version"] = str(promoted.get("version", "0.1.0-draft")).replace("-draft","-reviewed") - promoted["curation"] = {"reviewer": session.reviewer, "ledger_entries": len(session.ledger)} +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)} + concepts = [] for concept in session.draft_pack.concepts: if concept.status == "rejected": continue 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": {} + "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, sort_keys=False), encoding="utf-8") - (outdir/"concepts.yaml").write_text(yaml.safe_dump({"concepts": concepts}, sort_keys=False), encoding="utf-8") - (outdir/"review_ledger.json").write_text(json.dumps(session.model_dump(), indent=2), encoding="utf-8") + + (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": 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") diff --git a/src/didactopus/review_loader.py b/src/didactopus/review_loader.py index 5d5739f..e21269f 100644 --- a/src/didactopus/review_loader.py +++ b/src/didactopus/review_loader.py @@ -5,20 +5,38 @@ from .review_schema import DraftPackData, ConceptReviewEntry def load_draft_pack(pack_dir: str | Path) -> DraftPackData: pack_dir = Path(pack_dir) - data = yaml.safe_load((pack_dir / "concepts.yaml").read_text(encoding="utf-8")) or {} + concepts_yaml = yaml.safe_load((pack_dir / "concepts.yaml").read_text(encoding="utf-8")) or {} concepts = [] - for item in data.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", [])), - status=item.get("status","needs_review"), - notes=list(item.get("notes", [])), - )) - pack = yaml.safe_load((pack_dir / "pack.yaml").read_text(encoding="utf-8")) if (pack_dir/"pack.yaml").exists() else {} - attribution = json.loads((pack_dir / "license_attribution.json").read_text(encoding="utf-8")) if (pack_dir/"license_attribution.json").exists() else {} - def bullets(path): - return [line[2:] for line in path.read_text(encoding="utf-8").splitlines() if line.startswith("- ")] if path.exists() else [] - return DraftPackData(pack=pack or {}, concepts=concepts, conflicts=bullets(pack_dir/"conflict_report.md"), review_flags=bullets(pack_dir/"review_report.md"), attribution=attribution) + 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", [])), + status=item.get("status", "needs_review"), + notes=list(item.get("notes", [])), + ) + ) + + def bullets(path: Path) -> list[str]: + if not path.exists(): + return [] + return [line[2:] for line in path.read_text(encoding="utf-8").splitlines() if line.startswith("- ")] + + pack = {} + if (pack_dir / "pack.yaml").exists(): + pack = yaml.safe_load((pack_dir / "pack.yaml").read_text(encoding="utf-8")) or {} + + attribution = {} + if (pack_dir / "license_attribution.json").exists(): + attribution = json.loads((pack_dir / "license_attribution.json").read_text(encoding="utf-8")) + + return DraftPackData( + pack=pack, + concepts=concepts, + conflicts=bullets(pack_dir / "conflict_report.md"), + review_flags=bullets(pack_dir / "review_report.md"), + attribution=attribution, + ) diff --git a/src/didactopus/review_schema.py b/src/didactopus/review_schema.py index da90c6f..87b3889 100644 --- a/src/didactopus/review_schema.py +++ b/src/didactopus/review_schema.py @@ -2,7 +2,7 @@ from __future__ import annotations from pydantic import BaseModel, Field from typing import Literal -TrustStatus = Literal["trusted","provisional","rejected","needs_review"] +TrustStatus = Literal["trusted", "provisional", "rejected", "needs_review"] class ConceptReviewEntry(BaseModel): concept_id: str @@ -58,4 +58,3 @@ class ImportPreview(BaseModel): semantic_warnings: list[str] = Field(default_factory=list) graph_warnings: list[str] = Field(default_factory=list) path_warnings: list[str] = Field(default_factory=list) - coverage_warnings: list[str] = Field(default_factory=list) diff --git a/src/didactopus/semantic_qa.py b/src/didactopus/semantic_qa.py index a19f442..9a17f80 100644 --- a/src/didactopus/semantic_qa.py +++ b/src/didactopus/semantic_qa.py @@ -1,4 +1,50 @@ +from __future__ import annotations +import re +from difflib import SequenceMatcher from .pack_validator import load_pack_artifacts -def semantic_qa_for_pack(source_dir): + +BROAD_HINTS = {"and", "overview", "foundations", "introduction", "basics", "advanced"} + +def normalize_title(text: str) -> str: + return re.sub(r"[^a-z0-9]+", " ", text.lower()).strip() + +def similarity(a: str, b: str) -> float: + return SequenceMatcher(None, normalize_title(a), normalize_title(b)).ratio() + +def token_set(text: str) -> set[str]: + return {t for t in normalize_title(text).split() if t} + +def semantic_qa_for_pack(source_dir) -> dict: loaded = load_pack_artifacts(source_dir) - return {"warnings": [], "summary": {"semantic_warning_count": 0}} if loaded["ok"] else {"warnings": [], "summary": {"semantic_warning_count": 0}} + if not loaded["ok"]: + return {"warnings": [], "summary": {"semantic_warning_count": 0}} + pack = loaded["artifacts"]["pack"] + concepts = loaded["artifacts"]["concepts"].get("concepts", []) or [] + roadmap = loaded["artifacts"]["roadmap"].get("stages", []) or [] + warnings: list[str] = [] + for i in range(len(concepts)): + for j in range(i + 1, len(concepts)): + a = concepts[i]; b = concepts[j] + sim = similarity(a.get("title", ""), b.get("title", "")) + if sim >= 0.86 and a.get("id") != b.get("id"): + warnings.append(f"Near-duplicate concept titles: '{a.get('title')}' vs '{b.get('title')}'") + for concept in concepts: + title = concept.get("title", ""); toks = token_set(title) + if len(toks) >= 3 and (BROAD_HINTS & toks): + warnings.append(f"Concept '{title}' may be over-broad and may need splitting.") + if " and " in title.lower(): + warnings.append(f"Concept '{title}' is compound and may combine multiple ideas.") + for concept in concepts: + title = normalize_title(concept.get("title", "")); prereqs = concept.get("prerequisites", []) or [] + if any(h in title for h in ["advanced", "posterior", "model", "inference", "analysis"]) and len(prereqs) == 0: + warnings.append(f"Concept '{concept.get('title')}' looks advanced but has no prerequisites.") + concept_by_id = {c.get("id"): c for c in concepts if c.get("id")} + for idx in range(len(roadmap) - 1): + current_stage = roadmap[idx]; next_stage = roadmap[idx + 1] + current_titles = [concept_by_id[cid].get("title", "") for cid in current_stage.get("concepts", []) if cid in concept_by_id] + next_titles = [concept_by_id[cid].get("title", "") for cid in next_stage.get("concepts", []) if cid in concept_by_id] + current_tokens = set().union(*[token_set(t) for t in current_titles]) if current_titles else set() + next_tokens = set().union(*[token_set(t) for t in next_titles]) if next_titles else set() + if current_titles and next_titles and len(current_tokens & next_tokens) == 0: + warnings.append(f"Roadmap transition from stage '{current_stage.get('title')}' to '{next_stage.get('title')}' may lack a bridge concept.") + return {"warnings": warnings, "summary": {"semantic_warning_count": len(warnings), "pack_name": pack.get("name", "")}} diff --git a/src/didactopus/workspace_manager.py b/src/didactopus/workspace_manager.py index d4b4e62..5496061 100644 --- a/src/didactopus/workspace_manager.py +++ b/src/didactopus/workspace_manager.py @@ -1,37 +1,41 @@ +from __future__ import annotations from pathlib import Path from datetime import datetime, UTC import json, shutil from .review_schema import WorkspaceMeta, WorkspaceRegistry from .import_validator import preview_draft_pack_import -def utc_now(): +def utc_now() -> str: return datetime.now(UTC).isoformat() class WorkspaceManager: - def __init__(self, registry_path, default_workspace_root): + def __init__(self, registry_path: str | Path, default_workspace_root: str | Path) -> None: self.registry_path = Path(registry_path) self.default_workspace_root = Path(default_workspace_root) self.default_workspace_root.mkdir(parents=True, exist_ok=True) - def load_registry(self): + def load_registry(self) -> WorkspaceRegistry: if self.registry_path.exists(): return WorkspaceRegistry.model_validate(json.loads(self.registry_path.read_text(encoding="utf-8"))) return WorkspaceRegistry() - def save_registry(self, registry): + def save_registry(self, registry: WorkspaceRegistry) -> None: self.registry_path.write_text(registry.model_dump_json(indent=2), encoding="utf-8") - def list_workspaces(self): + def list_workspaces(self) -> WorkspaceRegistry: return self.load_registry() - def create_workspace(self, workspace_id, title, notes=""): + def create_workspace(self, workspace_id: str, title: str, notes: str = "") -> WorkspaceMeta: registry = self.load_registry() workspace_dir = self.default_workspace_root / workspace_id workspace_dir.mkdir(parents=True, exist_ok=True) draft_dir = workspace_dir / "draft_pack" draft_dir.mkdir(parents=True, exist_ok=True) if not (draft_dir / "pack.yaml").exists(): - (draft_dir / "pack.yaml").write_text(f"name: {workspace_id}\ndisplay_name: {title}\nversion: 0.1.0-draft\n", encoding="utf-8") + (draft_dir / "pack.yaml").write_text( + f"name: {workspace_id}\ndisplay_name: {title}\nversion: 0.1.0-draft\ndescription: Seed draft pack for workspace {workspace_id}\n", + encoding="utf-8" + ) if not (draft_dir / "concepts.yaml").exists(): (draft_dir / "concepts.yaml").write_text("concepts: []\n", encoding="utf-8") meta = WorkspaceMeta(workspace_id=workspace_id, title=title, path=str(workspace_dir), created_at=utc_now(), last_opened_at=utc_now(), notes=notes) @@ -40,33 +44,32 @@ class WorkspaceManager: self.save_registry(registry) return meta - def touch_recent(self, workspace_id): + def touch_recent(self, workspace_id: str) -> WorkspaceMeta | None: registry = self.load_registry() target = None for ws in registry.workspaces: if ws.workspace_id == workspace_id: - ws.last_opened_at = utc_now() - target = ws - break + ws.last_opened_at = utc_now(); target = ws; break if target is not None: registry.recent_workspace_ids = [workspace_id] + [w for w in registry.recent_workspace_ids if w != workspace_id] self.save_registry(registry) return target - def get_workspace(self, workspace_id): - for ws in self.load_registry().workspaces: - if ws.workspace_id == workspace_id: - return ws + def get_workspace(self, workspace_id: str) -> WorkspaceMeta | None: + registry = self.load_registry() + for ws in registry.workspaces: + if ws.workspace_id == workspace_id: return ws return None - def preview_import(self, source_dir, workspace_id): + def preview_import(self, source_dir: str | Path, workspace_id: str): preview = preview_draft_pack_import(source_dir, workspace_id) - if self.get_workspace(workspace_id) is not None: + existing = self.get_workspace(workspace_id) + if existing is not None: preview.overwrite_required = True preview.warnings.append(f"Workspace '{workspace_id}' already exists and import will overwrite draft_pack.") return preview - def import_draft_pack(self, source_dir, workspace_id, title=None, notes="", allow_overwrite=False): + def import_draft_pack(self, source_dir: str | Path, workspace_id: str, title: str | None = None, notes: str = "", allow_overwrite: bool = False) -> WorkspaceMeta: preview = self.preview_import(source_dir, workspace_id) if not preview.ok: raise ValueError("Draft pack preview failed: " + "; ".join(preview.errors)) @@ -76,7 +79,8 @@ class WorkspaceManager: meta = existing if existing is not None else self.create_workspace(workspace_id, title or workspace_id, notes=notes) if existing is not None: self.touch_recent(workspace_id) - target_draft = Path(meta.path) / "draft_pack" + workspace_dir = Path(meta.path) + target_draft = workspace_dir / "draft_pack" if target_draft.exists(): shutil.rmtree(target_draft) shutil.copytree(Path(source_dir), target_draft) diff --git a/tests/test_import_validator.py b/tests/test_import_validator.py index c0f1aa9..143f3d1 100644 --- a/tests/test_import_validator.py +++ b/tests/test_import_validator.py @@ -1,11 +1,11 @@ from pathlib import Path from didactopus.import_validator import preview_draft_pack_import -def test_preview_includes_coverage_warnings(tmp_path: Path) -> None: +def test_preview_includes_path_warnings(tmp_path: Path) -> None: (tmp_path / "pack.yaml").write_text("name: p\ndisplay_name: P\nversion: 0.1.0\n", encoding="utf-8") - (tmp_path / "concepts.yaml").write_text("concepts:\n - id: c1\n title: Foundations\n description: enough description here\n mastery_signals: [Explain foundations]\n", encoding="utf-8") + (tmp_path / "concepts.yaml").write_text("concepts:\n - id: c1\n title: Foundations\n description: foundations description enough\n prerequisites: []\n", encoding="utf-8") (tmp_path / "roadmap.yaml").write_text("stages:\n - id: s1\n title: One\n concepts: [c1]\n checkpoint: []\n", encoding="utf-8") (tmp_path / "projects.yaml").write_text("projects: []\n", encoding="utf-8") - (tmp_path / "rubrics.yaml").write_text("rubrics:\n - id: r1\n title: Style\n criteria: [formatting]\n", encoding="utf-8") + (tmp_path / "rubrics.yaml").write_text("rubrics: []\n", encoding="utf-8") preview = preview_draft_pack_import(tmp_path, "ws1") - assert isinstance(preview.coverage_warnings, list) + assert isinstance(preview.path_warnings, list) diff --git a/webui/index.html b/webui/index.html index 4ecb1aa..df9504e 100644 --- a/webui/index.html +++ b/webui/index.html @@ -6,7 +6,5 @@ Didactopus Review UI - -
- +
diff --git a/webui/package.json b/webui/package.json index 3da8e81..ed2121f 100644 --- a/webui/package.json +++ b/webui/package.json @@ -3,15 +3,7 @@ "private": true, "version": "0.1.0", "type": "module", - "scripts": { - "dev": "vite", - "build": "vite build" - }, - "dependencies": { - "react": "^18.3.1", - "react-dom": "^18.3.1" - }, - "devDependencies": { - "vite": "^5.4.0" - } + "scripts": {"dev": "vite", "build": "vite build"}, + "dependencies": {"react": "^18.3.1", "react-dom": "^18.3.1"}, + "devDependencies": {"vite": "^5.4.0"} } diff --git a/webui/src/App.jsx b/webui/src/App.jsx index c02feb7..8760a7e 100644 --- a/webui/src/App.jsx +++ b/webui/src/App.jsx @@ -1,5 +1,4 @@ import React, { useEffect, useMemo, useState } from "react"; - const API = "http://127.0.0.1:8765"; const statuses = ["needs_review", "trusted", "provisional", "rejected"]; @@ -17,147 +16,68 @@ export default function App() { async function loadRegistry() { const res = await fetch(`${API}/api/workspaces`); - const data = await res.json(); - setRegistry(data); + setRegistry(await res.json()); if (!session) setMessage("Choose, create, preview, or import a workspace."); } - - useEffect(() => { - loadRegistry().catch(() => setMessage("Could not connect to local review bridge. Start the Python bridge service first.")); - }, []); + useEffect(() => { loadRegistry().catch(() => setMessage("Could not connect to local review bridge. Start the Python bridge service first.")); }, []); async function createWorkspace() { if (!workspaceId || !workspaceTitle) return; - await fetch(`${API}/api/workspaces/create`, { - method: "POST", - headers: {"Content-Type": "application/json"}, - body: JSON.stringify({ workspace_id: workspaceId, title: workspaceTitle }) - }); - await loadRegistry(); - await openWorkspace(workspaceId); + await fetch(`${API}/api/workspaces/create`, {method: "POST", headers: {"Content-Type": "application/json"}, body: JSON.stringify({ workspace_id: workspaceId, title: workspaceTitle })}); + await loadRegistry(); await openWorkspace(workspaceId); } - async function previewImport() { if (!workspaceId || !importSource) return; - const res = await fetch(`${API}/api/workspaces/import-preview`, { - method: "POST", - headers: {"Content-Type": "application/json"}, - body: JSON.stringify({ workspace_id: workspaceId, source_dir: importSource }) - }); - const data = await res.json(); - setImportPreview(data); - setMessage(data.ok ? "Import preview ready." : "Import preview found blocking errors."); + const res = await fetch(`${API}/api/workspaces/import-preview`, {method: "POST", headers: {"Content-Type": "application/json"}, body: JSON.stringify({ workspace_id: workspaceId, source_dir: importSource })}); + const data = await res.json(); setImportPreview(data); setMessage(data.ok ? "Import preview ready." : "Import preview found blocking errors."); } - async function importWorkspace() { if (!workspaceId || !importSource) return; - const res = await fetch(`${API}/api/workspaces/import`, { - method: "POST", - headers: {"Content-Type": "application/json"}, - body: JSON.stringify({ - workspace_id: workspaceId, - title: workspaceTitle || workspaceId, - source_dir: importSource, - allow_overwrite: allowOverwrite - }) - }); + const res = await fetch(`${API}/api/workspaces/import`, {method: "POST", headers: {"Content-Type": "application/json"}, body: JSON.stringify({ workspace_id: workspaceId, title: workspaceTitle || workspaceId, source_dir: importSource, allow_overwrite: allowOverwrite })}); const data = await res.json(); - if (!data.ok) { - setMessage(data.error || "Import failed."); - return; - } - await loadRegistry(); - await openWorkspace(workspaceId); - setMessage(`Imported draft pack from ${importSource} into workspace ${workspaceId}.`); + if (!data.ok) { setMessage(data.error || "Import failed."); return; } + await loadRegistry(); await openWorkspace(workspaceId); setMessage(`Imported draft pack from ${importSource} into workspace ${workspaceId}.`); } - async function openWorkspace(id) { - const res = await fetch(`${API}/api/workspaces/open`, { - method: "POST", - headers: {"Content-Type": "application/json"}, - body: JSON.stringify({ workspace_id: id }) - }); - const opened = await res.json(); - if (!opened.ok) { - setMessage("Could not open workspace."); - return; - } - const sessionRes = await fetch(`${API}/api/load`); - const sessionData = await sessionRes.json(); - setSession(sessionData.session); - setSelectedId(sessionData.session?.draft_pack?.concepts?.[0]?.concept_id || ""); - setPendingActions([]); - setMessage(`Opened workspace ${id}.`); - await loadRegistry(); - } - - const selected = useMemo(() => { - if (!session) return null; - return session.draft_pack.concepts.find((c) => c.concept_id === selectedId) || null; - }, [session, selectedId]); - - function queueAction(action) { - setPendingActions((prev) => [...prev, action]); + const res = await fetch(`${API}/api/workspaces/open`, {method: "POST", headers: {"Content-Type": "application/json"}, body: JSON.stringify({ workspace_id: id })}); + const opened = await res.json(); if (!opened.ok) { setMessage("Could not open workspace."); return; } + const sessionRes = await fetch(`${API}/api/load`); const sessionData = await sessionRes.json(); + setSession(sessionData.session); setSelectedId(sessionData.session?.draft_pack?.concepts?.[0]?.concept_id || ""); setPendingActions([]); setMessage(`Opened workspace ${id}.`); await loadRegistry(); } + const selected = useMemo(() => session ? session.draft_pack.concepts.find((c) => c.concept_id === selectedId) || null : null, [session, selectedId]); + function queueAction(action) { setPendingActions((prev) => [...prev, action]); } function patchConcept(conceptId, patch, rationale) { if (!session) return; - const concepts = session.draft_pack.concepts.map((c) => - c.concept_id === conceptId ? { ...c, ...patch } : c - ); + const concepts = session.draft_pack.concepts.map((c) => c.concept_id === conceptId ? { ...c, ...patch } : c); setSession({ ...session, draft_pack: { ...session.draft_pack, concepts } }); - if (patch.status !== undefined) queueAction({ action_type: "set_status", target: conceptId, payload: { status: patch.status }, rationale }); if (patch.title !== undefined) queueAction({ action_type: "edit_title", target: conceptId, payload: { title: patch.title }, rationale }); if (patch.description !== undefined) queueAction({ action_type: "edit_description", target: conceptId, payload: { description: patch.description }, rationale }); if (patch.prerequisites !== undefined) queueAction({ action_type: "edit_prerequisites", target: conceptId, payload: { prerequisites: patch.prerequisites }, rationale }); if (patch.notes !== undefined) queueAction({ action_type: "edit_notes", target: conceptId, payload: { notes: patch.notes }, rationale }); } - function resolveConflict(conflict) { if (!session) return; - setSession({ - ...session, - draft_pack: { ...session.draft_pack, conflicts: session.draft_pack.conflicts.filter((c) => c !== conflict) } - }); + setSession({ ...session, draft_pack: { ...session.draft_pack, conflicts: session.draft_pack.conflicts.filter((c) => c !== conflict) } }); queueAction({ action_type: "resolve_conflict", target: "", payload: { conflict }, rationale: "Resolved in UI" }); } - async function saveChanges() { - if (!pendingActions.length) { - setMessage("No pending changes to save."); - return; - } - const res = await fetch(`${API}/api/save`, { - method: "POST", - headers: {"Content-Type": "application/json"}, - body: JSON.stringify({ actions: pendingActions }) - }); - const data = await res.json(); - setSession(data.session); - setPendingActions([]); - setMessage("Saved review state."); + if (!pendingActions.length) { setMessage("No pending changes to save."); return; } + const res = await fetch(`${API}/api/save`, {method: "POST", headers: {"Content-Type": "application/json"}, body: JSON.stringify({ actions: pendingActions })}); + const data = await res.json(); setSession(data.session); setPendingActions([]); setMessage("Saved review state."); } - async function exportPromoted() { - const res = await fetch(`${API}/api/export`, { - method: "POST", - headers: {"Content-Type": "application/json"}, - body: JSON.stringify({}) - }); - const data = await res.json(); - setMessage(`Exported promoted pack to ${data.promoted_pack_dir}`); + const res = await fetch(`${API}/api/export`, {method: "POST", headers: {"Content-Type": "application/json"}, body: JSON.stringify({})}); + const data = await res.json(); setMessage(`Exported promoted pack to ${data.promoted_pack_dir}`); } return (
-

Didactopus Full Pack Validation

-

- Reduce the activation-energy hump from generated draft packs to curated review workspaces - by previewing structural coherence, warnings, and overwrite risk before import. -

+

Didactopus Curriculum Path QA

+

Reduce activation-energy by surfacing roadmap and assessment progression problems before import.

{message}
@@ -176,12 +96,9 @@ export default function App() {

Preview / Import Draft Pack

- - -
- - -
+ + +

Recent

@@ -195,25 +112,10 @@ export default function App() { {importPreview && (
-
-

Import Preview

-
OK: {String(importPreview.ok)}
-
Overwrite Required: {String(importPreview.overwrite_required)}
-
Pack: {importPreview.summary?.display_name || importPreview.summary?.pack_name || "-"}
-
Version: {importPreview.summary?.version || "-"}
-
Concepts: {importPreview.summary?.concept_count ?? "-"}
-
Roadmap Stages: {importPreview.summary?.roadmap_stage_count ?? "-"}
-
Projects: {importPreview.summary?.project_count ?? "-"}
-
Rubrics: {importPreview.summary?.rubric_count ?? "-"}
-
-
-

Validation Errors

-
    {(importPreview.errors || []).length ? importPreview.errors.map((x, i) =>
  • {x}
    • ) :
  • none
    • }
-
-
-

Validation Warnings

-
    {(importPreview.warnings || []).length ? importPreview.warnings.map((x, i) =>
  • {x}
    • ) :
  • none
    • }
-
+

Import Preview

OK: {String(importPreview.ok)}
Overwrite Required: {String(importPreview.overwrite_required)}
Pack: {importPreview.summary?.display_name || importPreview.summary?.pack_name || "-"}
+

Validation Errors

    {(importPreview.errors || []).length ? importPreview.errors.map((x, i) =>
  • {x}
    • ) :
  • none
    • }
+

Graph QA Warnings

    {(importPreview.graph_warnings || []).length ? importPreview.graph_warnings.map((x, i) =>
  • {x}
    • ) :
  • none
    • }
+

Path Quality Warnings

    {(importPreview.path_warnings || []).length ? importPreview.path_warnings.map((x, i) =>
  • {x}
    • ) :
  • none
    • }
)} @@ -223,43 +125,23 @@ export default function App() {

Concepts

{session.draft_pack.concepts.map((c) => ( ))} -
- {selected && ( -
-

Concept Editor

- - -