Skip to content

Agent API

Jump to bottom
grisun0 edited this page Oct 10, 2026 · 37 revisions

API (page 1 of 2)

Pages: API.md, API_p2.md

readmenator/main.py

Depends on: readmenator/_app.py, readmenator/_config.py, readmenator/_mcp_server.py Imported by: readmenator.py

readmenator/_agent_injector.py

Imported by: readmenator/_pipeline.py, tests/test_agent_injector.py, tests/test_agent_output.py

readmenator/_agent_output.py

Depends on: readmenator/_cache.py, readmenator/_config.py, readmenator/_gitmeta.py, readmenator/_models.py, readmenator/_purpose.py, readmenator/_resolver.py, readmenator/_security.py Imported by: readmenator/_pipeline.py, tests/test_agent_friendliness.py, tests/test_agent_output.py

  • AgentOutputGenerator.__init__ (method) readmenator/_agent_output.py:77 def __init__(self, config) -- Store configuration for output paths and size budgets.
  • AgentOutputGenerator.generate (method) readmenator/_agent_output.py:81 def generate(self, nodes, edges, resolved_edges, analysis, analysis_v2, findings, layers, project_root) -- Write all agent output files and return the output directory path.
  • AgentOutputGenerator.keep (method) readmenator/_agent_output.py:525 def keep(file_id) -- Return whether a file belongs in the gotcha lists.

readmenator/_analytics.py

Depends on: readmenator/_config.py, readmenator/_models.py Imported by: readmenator/_documentation.py, readmenator/_explorer.py, readmenator/_exporter.py, readmenator/_pipeline.py, tests/test_interactive_graph.py

  • AnalyticsBuilder.__init__ (method) readmenator/_analytics.py:28 def __init__(self, config) -- Initialise with application configuration.
  • AnalyticsBuilder.build (method) readmenator/_analytics.py:36 def build(self, nodes, edges, resolved_edges, analysis, findings, layers, v2, hotspots) -- Build the full analytics payload.

readmenator/_analyzer.py

Depends on: readmenator/_config.py, readmenator/_models.py Imported by: readmenator/_graphrag.py, readmenator/_pipeline.py, readmenator/_wiki.py, tests/test_agent_friendliness.py, tests/test_analyzer.py

  • dominant_directory (function) readmenator/_analyzer.py:22 def dominant_directory(file_ids) -- Return the most informative directory label for a set of files.
  • GraphAnalyzer.__init__ (method) readmenator/_analyzer.py:54 def __init__(self, config) -- Initialise with application configuration.
  • GraphAnalyzer.analyze (method) readmenator/_analyzer.py:62 def analyze(self, nodes, edges, resolved_edges) -- Run the full analysis pipeline and return structured results.
  • GraphAnalyzer.partition (method) readmenator/_analyzer.py:268 def partition(self, ids, adjacency) -- Partition an arbitrary undirected id graph with deterministic Louvain.

readmenator/_app.py

Depends on: readmenator/_bundlegraph.py, readmenator/_cache.py, readmenator/_config.py, readmenator/_cursorrules_generator.py, readmenator/_dead_code.py, readmenator/_diagrams.py, readmenator/_explorer.py, readmenator/_gh_wiki.py, readmenator/_gitmeta.py, readmenator/_graphrag.py, readmenator/_layers.py, readmenator/_linter.py, readmenator/_models.py, readmenator/_pipeline.py, readmenator/_query.py, readmenator/_rank.py, readmenator/_refactorizer.py, readmenator/_resolver.py, readmenator/_video.py, readmenator/_watcher.py, readmenator/_yaralite.py Imported by: readmenator/__init__.py, readmenator/__main__.py, readmenator/_mcp_server.py, tests/test_agent_friendliness.py, tests/test_bundlegraph.py, tests/test_diagrams.py, tests/test_gh_wiki.py, tests/test_integration.py, tests/test_interactive_graph.py, tests/test_mcp_server.py, tests/test_video.py

  • readmenatorApplication.__init__ (method) readmenator/_app.py:50 def __init__(self, config)
  • readmenatorApplication.run (method) readmenator/_app.py:96 def run(self, target_dir, resolve_imports, run_analysis, run_security, run_v2_analysis)
  • readmenatorApplication.check_freshness (method) readmenator/_app.py:238 def check_freshness(self, target_dir) -- Compare the MANIFEST source fingerprint against the current sources.
  • readmenatorApplication.publish_github_wiki (method) readmenator/_app.py:301 def publish_github_wiki(self, target_dir, dry_run) -- Mirror the generated wiki, agent docs, and knowledge base to the GitHub wiki.
  • readmenatorApplication.generate_uml_code (method) readmenator/_app.py:357 def generate_uml_code(self, target_dir, language, output_path)
  • readmenatorApplication.update (method) readmenator/_app.py:424 def update(self, target_dir, run_security)
  • readmenatorApplication.query (method) readmenator/_app.py:547 def query(self, target_dir, question)
  • readmenatorApplication.explain (method) readmenator/_app.py:552 def explain(self, target_dir, symbol_name)
  • readmenatorApplication.find_path (method) readmenator/_app.py:564 def find_path(self, target_dir, symbol_a, symbol_b)
  • readmenatorApplication.summary (method) readmenator/_app.py:577 def summary(self, target_dir)
  • readmenatorApplication.rank_query (method) readmenator/_app.py:582 def rank_query(self, target_dir, query, top_n) -- Run a ranked query against the knowledge graph.
  • readmenatorApplication.rebuild (method) readmenator/_app.py:612 def rebuild(self, target_dir, run_security)
  • readmenatorApplication.analyze (method) readmenator/_app.py:615 def analyze(self, target_dir)
  • readmenatorApplication.export_json (method) readmenator/_app.py:619 def export_json(self, target_dir, output_path)
  • readmenatorApplication.export_html (method) readmenator/_app.py:636 def export_html(self, target_dir, output_path)
  • readmenatorApplication.export_svg (method) readmenator/_app.py:647 def export_svg(self, target_dir, output_path)
  • readmenatorApplication.export (method) readmenator/_app.py:658 def export(self, target_dir)
  • readmenatorApplication.export_forcegraph (method) readmenator/_app.py:817 def export_forcegraph(self, target_dir, output_path) -- Export the force-graph explorer HTML document.
  • readmenatorApplication.export_bundlegraph (method) readmenator/_app.py:836 def export_bundlegraph(self, target_dir, output_path) -- Export the edge bundle explorer HTML document (circle and sphere views).
  • readmenatorApplication.explorer_state (method) readmenator/_app.py:862 def explorer_state(self, target_dir) -- Build explorer state for the local HTTP server.
  • readmenatorApplication.serve_explorer (method) readmenator/_app.py:878 def serve_explorer(self, target_dir, open_browser) -- Serve the local explorer UI until interrupted.
  • readmenatorApplication.analytics (method) readmenator/_app.py:891 def analytics(self, target_dir) -- Compute the corpus analytics payload.
  • readmenatorApplication.scan_texts (method) readmenator/_app.py:908 def scan_texts(self, target_dir) -- Build scan-text blobs for every file in the project.
  • readmenatorApplication.near (method) readmenator/_app.py:920 def near(self, target_dir, query, top_k) -- Find semantically similar files for a query file or text.
  • readmenatorApplication.audit_provenance (method) readmenator/_app.py:934 def audit_provenance(self, target_dir) -- Audit security findings by evidence provenance.
  • readmenatorApplication.validate_yaralite (method) readmenator/_app.py:957 def validate_yaralite(self, target_dir) -- Validate the project YARA-lite rules file.
  • readmenatorApplication.export_graphml (method) readmenator/_app.py:971 def export_graphml(self, target_dir, output_path)
  • readmenatorApplication.export_cypher (method) readmenator/_app.py:982 def export_cypher(self, target_dir, output_path)
  • readmenatorApplication.export_obsidian (method) readmenator/_app.py:998 def export_obsidian(self, target_dir, output_dir)
  • readmenatorApplication.export_wiki (method) readmenator/_app.py:1013 def export_wiki(self, target_dir, output_dir) -- Generate the navigable agent wiki for the target project.
  • readmenatorApplication.lint_wiki (method) readmenator/_app.py:1036 def lint_wiki(self, target_dir) -- Check wiki health and log reported issues.
  • readmenatorApplication.export_diagrams (method) readmenator/_app.py:1054 def export_diagrams(self, target_dir, output_dir, full) -- Export all five interactive system maps plus a gallery index.
  • readmenatorApplication.export_diagram (method) readmenator/_app.py:1120 def export_diagram(self, target_dir, kind, output_path, full) -- Export a single interactive system map as standalone HTML.
  • readmenatorApplication.export_pages (method) readmenator/_app.py:1159 def export_pages(self, target_dir, output_dir, full) -- Publish all system maps plus a gallery index as a static site.
  • readmenatorApplication.export_video (method) readmenator/_app.py:1203 def export_video(self, target_dir, output_path) -- Render the cinematic overview video for the target project.
  • readmenatorApplication.memory (method) readmenator/_app.py:1365 def memory(self, target_dir) -- Return MEMORY.md, generating it first when missing.
  • readmenatorApplication.remember (method) readmenator/_app.py:1388 def remember(self, target_dir, note, kind) -- Append a note to the preserved MEMORY.md session log.
  • readmenatorApplication.install_skills (method) readmenator/_app.py:1402 def install_skills(self, target_dir, target) -- Install the packaged agent skills into the project.
  • readmenatorApplication.build_graphrag (method) readmenator/_app.py:1414 def build_graphrag(self, target_dir) -- Scan, analyse, and write the GraphRAG index for a project.
  • readmenatorApplication.graphrag_search (method) readmenator/_app.py:1437 def graphrag_search(self, target_dir, query, mode, budget_tokens) -- Answer a question with GraphRAG retrieval over the persisted index.
  • readmenatorApplication.watch (method) readmenator/_app.py:1458 def watch(self, target_dir)
  • readmenatorApplication.on_change (method) readmenator/_app.py:1462 def on_change()
  • readmenatorApplication.audit (method) readmenator/_app.py:1468 def audit(self, target_dir)
  • readmenatorApplication.audit_deep (method) readmenator/_app.py:1475 def audit_deep(self, target_dir)
  • readmenatorApplication.export_sarif (method) readmenator/_app.py:1495 def export_sarif(self, target_dir, output_path)
  • readmenatorApplication.export_rules (method) readmenator/_app.py:1505 def export_rules(self, target_dir, output_dir)
  • readmenatorApplication.detect_layers (method) readmenator/_app.py:1515 def detect_layers(self, target_dir)
  • readmenatorApplication.lint (method) readmenator/_app.py:1525 def lint(self, target_dir)
  • readmenatorApplication.strip_dead_code (method) readmenator/_app.py:1538 def strip_dead_code(self, target_dir)
  • readmenatorApplication.generate_cursorrules (method) readmenator/_app.py:1548 def generate_cursorrules(self, target_dir)
  • readmenatorApplication.refactor_monolith (method) readmenator/_app.py:1563 def refactor_monolith(self, target_dir)

readmenator/_bundlegraph.py

Depends on: readmenator/_bundlegraph_page.py, readmenator/_config.py, readmenator/_forcegraph.py, readmenator/_graphlayout.py Imported by: readmenator/_app.py, readmenator/_pipeline.py, tests/test_bundlegraph.py

  • BundleGraphRenderer.__init__ (method) readmenator/_bundlegraph.py:51 def __init__(self, config) -- Initialise with application configuration.
  • BundleGraphRenderer.build_payload (method) readmenator/_bundlegraph.py:60 def build_payload(self, force_payload) -- Derive the bundle payload from a force-graph payload.
  • BundleGraphRenderer.page_settings (method) readmenator/_bundlegraph.py:147 def page_settings(self, force_payload, explorer_href) -- Collect the page settings serialized into the HTML.
  • BundleGraphRenderer.render (method) readmenator/_bundlegraph.py:186 def render(self, force_payload, title, home_href, explorer_href) -- Render the standalone edge bundle explorer HTML document.
  • BundleGraphRenderer.write (method) readmenator/_bundlegraph.py:222 def write(self, output_path, force_payload, title, home_href, explorer_href) -- Write the edge bundle explorer HTML document.
  • BundleGraphRenderer.thumbnail_svg (method) readmenator/_bundlegraph.py:248 def thumbnail_svg(self, force_payload) -- Render a small circular bundle preview as inline SVG.

readmenator/_cache.py

Depends on: readmenator/_config.py Imported by: readmenator/_agent_output.py, readmenator/_app.py, tests/test_agent_friendliness.py, tests/test_cache.py

readmenator/_category.py

Imported by: readmenator/__init__.py, readmenator/_explain.py, readmenator/_graphrag.py, readmenator/_models.py, readmenator/_pipeline.py, readmenator/_projections.py, readmenator/_query.py, readmenator/_rank.py, tests/test_ranking.py

readmenator/_concepts.py

Depends on: readmenator/_config.py, readmenator/_models.py Imported by: readmenator/__init__.py, readmenator/_pipeline.py, tests/test_concepts.py

  • verb_for_relation (function) readmenator/_concepts.py:33 def verb_for_relation(relation) -- Return the verb label for a structural edge relation.
  • ConceptExtractor.__init__ (method) readmenator/_concepts.py:41 def __init__(self, config) -- Store configuration for concept extraction budgets.
  • ConceptExtractor.extract (method) readmenator/_concepts.py:47 def extract(self, nodes, edges, resolved_edges) -- Build concepts and verb relations from structural topology.

readmenator/_cpg.py

Depends on: readmenator/_models.py Imported by: readmenator/_documentation.py, readmenator/_pipeline.py, tests/test_cpg.py

  • CodePropertyGraph.__init__ (method) readmenator/_cpg.py:26 def __init__(self, privacy_mode, cpg_context)
  • CodePropertyGraph.generate (method) readmenator/_cpg.py:30 def generate(self, nodes, edges, resolved_edges, analysis, findings) -- Generate the CPG JSON-LD string embeddable in markdown.

readmenator/_cursorrules_generator.py

Depends on: readmenator/_config.py, readmenator/_layers.py, readmenator/_models.py Imported by: readmenator/_app.py, tests/test_cursorrules.py

readmenator/_dataflow.py

Depends on: readmenator/_config.py, readmenator/_models.py Imported by: readmenator/_pipeline.py, tests/test_dataflow.py

  • DataflowAnalyzer.__init__ (method) readmenator/_dataflow.py:125 def __init__(self, config) -- Store configuration for enable flag and issue caps.
  • DataflowAnalyzer.analyze (method) readmenator/_dataflow.py:129 def analyze(self, nodes, content_map) -- Check every function body span and return capped issues.

readmenator/_dead_code.py

Depends on: readmenator/_config.py, readmenator/_models.py Imported by: readmenator/_app.py, tests/test_dead_code.py

readmenator/_diagrams.py

Depends on: readmenator/_config.py, readmenator/_models.py Imported by: readmenator/__init__.py, readmenator/_app.py, readmenator/_pipeline.py, tests/test_agent_friendliness.py, tests/test_diagrams.py, tests/test_interactive_graph.py

  • SystemMapValidator.__init__ (method) readmenator/_diagrams.py:233 def __init__(self, config) -- Initialise the validator with application configuration.
  • SystemMapValidator.validate (method) readmenator/_diagrams.py:262 def validate(self, system_map) -- Validate a system map and return a deterministic receipt.
  • SystemMapBuilder.__init__ (method) readmenator/_diagrams.py:483 def __init__(self, config) -- Initialise the builder with application configuration.
  • SystemMapBuilder.supported_kinds (method) readmenator/_diagrams.py:492 def supported_kinds(self) -- Return the supported diagram kind identifiers.
  • SystemMapBuilder.build (method) readmenator/_diagrams.py:513 def build(self, nodes, edges, resolved_edges, layers, findings, analysis, kind, full) -- Build one deterministic system map of the requested kind.
  • SystemMapBuilder.build_all (method) readmenator/_diagrams.py:572 def build_all(self, nodes, edges, resolved_edges, layers, findings, analysis, full) -- Build all five diagram kinds deterministically.
  • SystemMapBuilder.compare (method) readmenator/_diagrams.py:603 def compare(self, base, head) -- Compare two maps of the same kind as before, delta, and after.
  • InteractiveMapRenderer.__init__ (method) readmenator/_diagrams.py:1523 def __init__(self, config) -- Initialise the renderer with application configuration.
  • InteractiveMapRenderer.render (method) readmenator/_diagrams.py:1552 def render(self, system_map) -- Render a system map as a self-contained HTML document.
  • InteractiveMapRenderer.write (method) readmenator/_diagrams.py:1643 def write(self, system_map, output_path) -- Render a system map and write it to a relative output path.
  • VisNetworkRenderer.__init__ (method) readmenator/_diagrams.py:2234 def __init__(self, config) -- Initialise the renderer with application configuration.
  • VisNetworkRenderer.render (method) readmenator/_diagrams.py:2242 def render(self, system_map) -- Render a system map as a vis.js network HTML document.
  • VisNetworkRenderer.write (method) readmenator/_diagrams.py:2364 def write(self, system_map, output_path) -- Render a vis.js map and write it to a relative output path.
  • DocsSitePublisher.__init__ (method) readmenator/_diagrams.py:3217 def __init__(self, config) -- Initialise the publisher with application configuration.
  • DocsSitePublisher.description_for (method) readmenator/_diagrams.py:3227 def description_for(self, kind) -- Return the gallery description for a diagram kind.
  • DocsSitePublisher.publish (method) readmenator/_diagrams.py:3241 def publish(self, maps, project_name, output_dir, stats, renderer, project_root, video_rel, doc_entries, extra_cards) -- Publish maps and a gallery index into a documentation directory.
  • DocsSitePublisher.collect_doc_sources (method) readmenator/_diagrams.py:3335 def collect_doc_sources(self, project_root) -- Collect generated markdown sources for the static site.
  • DocsSitePublisher.publish_assets (method) readmenator/_diagrams.py:3361 def publish_assets(self, project_root, output_dir) -- Copy overview video and markdown docs into the static site.
  • DocsSitePublisher.render_llms_txt (method) readmenator/_diagrams.py:3530 def render_llms_txt(self, project_name, maps, stats, href_prefix, doc_entries) -- Render an llms.txt entry point so agents can navigate the site as text.
  • DocsSitePublisher.order (method) readmenator/_diagrams.py:3581 def order(entry) -- Sort entry points first, then alphabetically.
  • DocsSitePublisher.render_index (method) readmenator/_diagrams.py:3609 def render_index(self, project_name, maps, stats, href_prefix, video_rel, doc_entries, poster_rel, extra_cards) -- Render the gallery index page for published maps.
  • DocsSitePublisher.doc_order (method) readmenator/_diagrams.py:3805 def doc_order(base) -- Entry points first, then alphabetical.

readmenator/_documentation.py

Depends on: readmenator/_analytics.py, readmenator/_config.py, readmenator/_cpg.py, readmenator/_forcegraph.py, readmenator/_mermaid.py, readmenator/_models.py, readmenator/_rank.py, readmenator/_uml.py Imported by: readmenator/_pipeline.py, tests/test_documentation.py

readmenator/_embed.py

Depends on: readmenator/_config.py Imported by: readmenator/_pipeline.py, tests/test_interactive_graph.py

  • Embedder.__init__ (method) readmenator/_embed.py:42 def __init__(self, config) -- Initialise with application configuration.
  • Embedder.dependencies_available (method) readmenator/_embed.py:50 def dependencies_available(self) -- Return True when sentence-transformers is importable.
  • Embedder.encode (method) readmenator/_embed.py:58 def encode(self, texts) -- Encode texts into L2-normalized vectors when available.
  • Embedder.near_jaccard (method) readmenator/_embed.py:75 def near_jaccard(self, query, corpus, top_k) -- Find nearest neighbors with offline Jaccard similarity.
  • Embedder.cluster_jaccard (method) readmenator/_embed.py:99 def cluster_jaccard(self, corpus, threshold) -- Group files into similarity clusters with union-find.
  • Embedder.find (method) readmenator/_embed.py:115 def find(item) -- Find the union-find root for an item.
  • Embedder.union (method) readmenator/_embed.py:122 def union(left, right) -- Merge two union-find sets.
  • Embedder.project_jaccard (method) readmenator/_embed.py:138 def project_jaccard(self, corpus) -- Project files to 2D with a deterministic radial layout.

readmenator/_exclusions.py

Depends on: readmenator/_config.py Imported by: readmenator/_pipeline.py, tests/test_interactive_graph.py

  • ExclusionEntry.matches (method) readmenator/_exclusions.py:27 def matches(self, file_path, rule_id) -- Return True when this entry suppresses the finding.
  • ExclusionList.__init__ (method) readmenator/_exclusions.py:47 def __init__(self, config) -- Initialise with application configuration.
  • ExclusionList.entries (method) readmenator/_exclusions.py:58 def entries(self) -- Return the loaded exclusion entries.
  • ExclusionList.load (method) readmenator/_exclusions.py:62 def load(self, project_root) -- Load exclusions from the project blocklist file.
  • ExclusionList.is_excluded (method) readmenator/_exclusions.py:86 def is_excluded(self, file_path, rule_id) -- Return True when a finding is suppressed by the blocklist.
  • ExclusionList.filter_findings (method) readmenator/_exclusions.py:98 def filter_findings(self, findings) -- Remove excluded findings from a finding list.
  • ExclusionList.parse_exclusions (method) readmenator/_exclusions.py:114 def parse_exclusions(text) -- Parse the minimal exclusions YAML into entries.

readmenator/_explain.py

Depends on: readmenator/_category.py, readmenator/_rank.py Imported by: tests/test_ranking.py

  • explain_rank (function) readmenator/_explain.py:16 def explain_rank(node_id, ranked, category) -- Return a detailed breakdown of why node_id has its rank.
  • rank_summary (function) readmenator/_explain.py:140 def rank_summary(ranked, top_n) -- Return a short summary of the top-N ranked results.

readmenator/_explorer.py

Depends on: readmenator/_analytics.py, readmenator/_config.py, readmenator/_forcegraph.py, readmenator/_models.py Imported by: readmenator/_app.py, tests/test_interactive_graph.py

  • ExplorerState.__init__ (method) readmenator/_explorer.py:26 def __init__(self, config, nodes, edges, resolved_edges, analysis, findings, layers) -- Initialise explorer state and precompute payloads.
  • ExplorerState.samples (method) readmenator/_explorer.py:61 def samples(self) -- Return a compact per-file sample listing.
  • _Handler.log_message (method) readmenator/_explorer.py:84 def log_message(self, fmt) -- Silence the default access log.
  • _Handler.do_GET (method) readmenator/_explorer.py:88 def do_GET(self) -- Dispatch GET routes for HTML and JSON APIs.
  • _Handler.find_free_port (method) readmenator/_explorer.py:139 def find_free_port(preferred) -- Find a free TCP port, preferring the configured value.
  • _Handler.serve (method) readmenator/_explorer.py:158 def serve(state, host, port, open_browser) -- Serve the explorer state until interrupted.
  • _Handler.build_state (method) readmenator/_explorer.py:191 def build_state(config, nodes, edges, resolved_edges, analysis, findings, layers) -- Build explorer state without starting the server.
  • _Handler.write_static (method) readmenator/_explorer.py:217 def write_static(state, output_dir, filename) -- Write the explorer HTML to a static file.

readmenator/_exporter.py

Depends on: readmenator/_analytics.py, readmenator/_config.py, readmenator/_forcegraph.py, readmenator/_models.py Imported by: readmenator/_pipeline.py, tests/test_exporter.py, tests/test_interactive_graph.py

  • GraphExporter.__init__ (method) readmenator/_exporter.py:36 def __init__(self, config) -- Initialise with application configuration.
  • GraphExporter.to_json (method) readmenator/_exporter.py:44 def to_json(self, nodes, edges, resolved_edges, analysis, findings, concept_graph) -- Export the graph as a node-link JSON string.
  • GraphExporter.to_html (method) readmenator/_exporter.py:183 def to_html(self, nodes, edges, resolved_edges, analysis, findings) -- Generate a standalone interactive HTML graph page.
  • GraphExporter.to_svg (method) readmenator/_exporter.py:482 def to_svg(self, nodes, edges, resolved_edges, analysis) -- Generate a static SVG representation of the graph.
  • GraphExporter.to_graphml (method) readmenator/_exporter.py:696 def to_graphml(self, nodes, edges, resolved_edges, analysis) -- Export the graph as GraphML (Gephi/yEd compatible).
  • GraphExporter.to_cypher (method) readmenator/_exporter.py:773 def to_cypher(self, nodes, edges, resolved_edges, analysis, findings, concept_graph) -- Export the graph as native Cypher CREATE statements.
  • GraphExporter.to_obsidian (method) readmenator/_exporter.py:895 def to_obsidian(self, nodes, edges, output_dir, analysis, concept_graph) -- Export the graph as an Obsidian vault with wikilinks.
  • GraphExporter.to_forcegraph (method) readmenator/_exporter.py:1020 def to_forcegraph(self, nodes, edges, resolved_edges, analysis, layers, findings, analytics) -- Generate the force-graph explorer HTML document.

readmenator/_forcegraph.py

Depends on: readmenator/_config.py, readmenator/_forcegraph_page.py, readmenator/_graphlayout.py, readmenator/_models.py, readmenator/_purpose.py, readmenator/_rank.py, readmenator/_resolver.py Imported by: readmenator/_bundlegraph.py, readmenator/_documentation.py, readmenator/_explorer.py, readmenator/_exporter.py, readmenator/_pipeline.py, tests/test_bundlegraph.py, tests/test_interactive_graph.py

  • family_color_from_name (function) readmenator/_forcegraph.py:34 def family_color_from_name(name, sat_base, sat_span, light_base, light_span) -- Derive a stable, visually-distinct HSL color from a label.
  • node_value (function) readmenator/_forcegraph.py:62 def node_value(symbols, degree) -- Scale a node value with log2 dampening.
  • ForceGraphRenderer.__init__ (method) readmenator/_forcegraph.py:78 def __init__(self, config) -- Initialise with application configuration.
  • ForceGraphRenderer.node_palette (method) readmenator/_forcegraph.py:86 def node_palette(self) -- Return the node-type color palette from configuration.
  • ForceGraphRenderer.edge_palette (method) readmenator/_forcegraph.py:90 def edge_palette(self) -- Return the edge-relation color palette from configuration.
  • ForceGraphRenderer.vendor_source (method) readmenator/_forcegraph.py:94 def vendor_source(self) -- Return the path of the vendored 2D engine shipped in the package.
  • ForceGraphRenderer.vendor_href (method) readmenator/_forcegraph.py:102 def vendor_href(self) -- Return the relative vendor script href used beside the page.
  • ForceGraphRenderer.build_payload (method) readmenator/_forcegraph.py:107 def build_payload(self, nodes, edges, resolved_edges, analysis, layers, findings) -- Build a heterogeneous graph payload for the explorer.
  • ForceGraphRenderer.file_of (method) readmenator/_forcegraph.py:141 def file_of(edge_id) -- Map a symbol-scoped edge endpoint to its file identifier.
  • ForceGraphRenderer.add_node (method) readmenator/_forcegraph.py:195 def add_node(node_id, label, node_type) -- Insert a node unless already present.
  • ForceGraphRenderer.render (method) readmenator/_forcegraph.py:283 def render(self, payload, analytics, title, home_href) -- Render the standalone force-graph explorer HTML document.
  • ForceGraphRenderer.group_colors (method) readmenator/_forcegraph.py:326 def group_colors(self, payload) -- Return stable colors for the layer and language groupings in a payload.
  • ForceGraphRenderer.page_settings (method) readmenator/_forcegraph.py:349 def page_settings(self, payload) -- Collect the explorer page settings serialized into the HTML.
  • ForceGraphRenderer.family_color (method) readmenator/_forcegraph.py:418 def family_color(self, name) -- Return the configured stable hash color for a group name.
  • ForceGraphRenderer.thumbnail_svg (method) readmenator/_forcegraph.py:446 def thumbnail_svg(self, payload) -- Render a small ForceAtlas2 preview of the file graph as inline SVG.
  • ForceGraphRenderer.write (method) readmenator/_forcegraph.py:486 def write(self, output_path, payload, analytics, title, home_href) -- Write the explorer HTML plus the vendored engine beside it.
  • ForceGraphRenderer.copy_vendor (method) readmenator/_forcegraph.py:513 def copy_vendor(self, dest_dir) -- Copy the vendored 2D engine next to an exported page.

readmenator/_gh_wiki.py

Depends on: readmenator/_config.py, readmenator/_gitmeta.py Imported by: readmenator/_app.py, readmenator/_pipeline.py, tests/test_gh_wiki.py

  • GitHubWikiPublisher.__init__ (method) readmenator/_gh_wiki.py:62 def __init__(self, config, runner) -- Store configuration and the subprocess runner (injectable for tests).
  • GitHubWikiPublisher.page_name (method) readmenator/_gh_wiki.py:72 def page_name(self, rel_path) -- Map a generated markdown path to its flat GitHub wiki page name.
  • GitHubWikiPublisher.collect_sources (method) readmenator/_gh_wiki.py:96 def collect_sources(self, project_root) -- List project-relative markdown sources to publish, sorted.
  • GitHubWikiPublisher.rewrite (method) readmenator/_gh_wiki.py:129 def rewrite(self, text, rel_path, names, project_root, blob_base) -- Rewrite relative doc links to wiki pages and paths to source permalinks.
  • GitHubWikiPublisher.link (method) readmenator/_gh_wiki.py:151 def link(match) -- Replace one relative markdown link when its target is published.
  • GitHubWikiPublisher.permalink (method) readmenator/_gh_wiki.py:164 def permalink(match) -- Link a backticked project file (optionally with a line) to source.
  • GitHubWikiPublisher.render (method) readmenator/_gh_wiki.py:179 def render(self, project_root, remote) -- Render every wiki page, including sidebar and footer.
  • GitHubWikiPublisher.wiki_remote (method) readmenator/_gh_wiki.py:249 def wiki_remote(self, project_root) -- Resolve the wiki remote from config, gh, or the git origin.
  • GitHubWikiPublisher.publish (method) readmenator/_gh_wiki.py:313 def publish(self, project_root, dry_run) -- Render pages and push them to the GitHub wiki (or a local folder).

readmenator/_gitmeta.py

Imported by: readmenator/_agent_output.py, readmenator/_app.py, readmenator/_gh_wiki.py, readmenator/_memory.py, tests/test_agent_friendliness.py

  • read_git_head (function) readmenator/_gitmeta.py:84 def read_git_head(project_root) -- Return the current commit and branch of a project, when available.

readmenator/_graphlayout.py

Imported by: readmenator/_bundlegraph.py, readmenator/_forcegraph.py, readmenator/_video.py, tests/test_graphlayout.py

  • ForceAtlas2Settings.forceatlas2_frames (method) readmenator/_graphlayout.py:70 def forceatlas2_frames(ids, edges, settings) -- Run ForceAtlas2 and return evenly spaced layout snapshots.
  • ForceAtlas2Settings.fit_frames (method) readmenator/_graphlayout.py:218 def fit_frames(frames, box, margin, trim) -- Map raw snapshots into a pixel box using the final layout's bounds.
  • ForceAtlas2Settings.interpolate_frames (method) readmenator/_graphlayout.py:263 def interpolate_frames(frames, t) -- Linear interpolation between snapshots for a progress t in [0, 1].
  • BundleLayout.hierarchical_edge_bundling (method) readmenator/_graphlayout.py:371 def hierarchical_edge_bundling(groups, edges, center, radius, beta, samples, group_gap, inner_ratio) -- Lay leaves on a circle by group and bundle edges through the hierarchy.
  • BundleLayout.fibonacci_sphere (method) readmenator/_graphlayout.py:426 def fibonacci_sphere(count) -- Return count nearly uniform unit vectors on a golden-angle spiral.
  • SphereBundleLayout.spherical_edge_bundling (method) readmenator/_graphlayout.py:513 def spherical_edge_bundling(groups, edges, radius, beta, samples, inner_ratio) -- Lay leaves on a sphere in community caps and bundle edges through the hierarchy.
  • SphereBundleLayout.normalize_cloud (method) readmenator/_graphlayout.py:571 def normalize_cloud(points, quantile, max_radius) -- Center a 3D point cloud, scale a radius quantile to 1, and pull outliers in.

readmenator/_graphrag.py

Depends on: readmenator/_analyzer.py, readmenator/_category.py, readmenator/_config.py, readmenator/_models.py, readmenator/_purpose.py, readmenator/_rank.py, readmenator/_resolver.py Imported by: readmenator/_app.py, readmenator/_pipeline.py, tests/test_graphrag.py, tests/test_memory.py

  • GraphRagIndex.to_dict (method) readmenator/_graphrag.py:186 def to_dict(self) -- Serialise the index into JSON-compatible primitives.
  • GraphRagIndex.from_dict (method) readmenator/_graphrag.py:197 def from_dict(cls, data) -- Rebuild an index from :meth:to_dict output.
  • RagContext.tokenize (method) readmenator/_graphrag.py:240 def tokenize(text, min_len, stopwords) -- Split text into lowercase retrieval tokens.
  • Bm25Index.__init__ (method) readmenator/_graphrag.py:270 def __init__(self, documents, k1, b) -- Index token documents.
  • Bm25Index.scores (method) readmenator/_graphrag.py:298 def scores(self, query) -- Return the BM25 score of every document for the query tokens.
  • GraphRagBuilder.__init__ (method) readmenator/_graphrag.py:348 def __init__(self, config) -- Initialise with application configuration.
  • GraphRagBuilder.build (method) readmenator/_graphrag.py:358 def build(self, nodes, edges, resolved_edges, analysis, layers, findings, analysis_v2, concept_graph, content_map... -- Build entities, relationships, text units, and community reports.
  • GraphRagBuilder.add_relation (method) readmenator/_graphrag.py:406 def add_relation(source, target, relation, description, confidence) -- Insert a relationship once, keyed by endpoints and relation.
  • GraphRagBuilder.resolve_symbol (method) readmenator/_graphrag.py:452 def resolve_symbol(file_id, name) -- Resolve a symbol name inside a file, else a globally unique name.
  • GraphRagSearcher.__init__ (method) readmenator/_graphrag.py:945 def __init__(self, config, index) -- Prepare lexical indexes and the entity random-walk graph.
  • GraphRagSearcher.choose_mode (method) readmenator/_graphrag.py:987 def choose_mode(self, query) -- Pick local or global retrieval for a query.
  • GraphRagSearcher.search (method) readmenator/_graphrag.py:1004 def search(self, query, mode, budget_tokens) -- Run local, global, or automatically chosen retrieval.
  • GraphRagSearcher.local_search (method) readmenator/_graphrag.py:1025 def local_search(self, query, budget_tokens) -- Entity-centric retrieval: BM25 seeds expanded by Personalized PageRank.
  • GraphRagSearcher.global_search (method) readmenator/_graphrag.py:1106 def global_search(self, query, budget_tokens) -- Map-reduce over community reports for broad, corpus-level questions.
  • GraphRagStore.__init__ (method) readmenator/_graphrag.py:1215 def __init__(self, config) -- Initialise with application configuration.
  • GraphRagStore.directory (method) readmenator/_graphrag.py:1223 def directory(self, project_root) -- Return the output directory for a project root.
  • GraphRagStore.write (method) readmenator/_graphrag.py:1227 def write(self, index, project_root) -- Write index.json, JSONL tables, and REPORTS.md.
  • GraphRagStore.load (method) readmenator/_graphrag.py:1257 def load(self, project_root) -- Load a previously written index, or None when missing or invalid.
  • GraphRagStore.render_reports (method) readmenator/_graphrag.py:1279 def render_reports(index) -- Render the community report hierarchy as greppable Markdown.

readmenator/_hotspots.py

Depends on: readmenator/_config.py, readmenator/_models.py Imported by: readmenator/_pipeline.py, tests/test_hotspots.py

  • HotspotAnalyzer.__init__ (method) readmenator/_hotspots.py:31 def __init__(self, config)
  • HotspotAnalyzer.analyze_hotspots (method) readmenator/_hotspots.py:34 def analyze_hotspots(self, nodes, edges, resolved_edges) -- Rank files by combined complexity and centrality scores.
  • HotspotAnalyzer.detect_cycles (method) readmenator/_hotspots.py:90 def detect_cycles(self, nodes, resolved_edges) -- Detect cycles in the resolved import graph using DFS.
  • HotspotAnalyzer.analyze_change_impact (method) readmenator/_hotspots.py:155 def analyze_change_impact(self, nodes, resolved_edges) -- Compute change impact for every file in the project.

readmenator/_layer_rules.py

Depends on: readmenator/_config.py, readmenator/_models.py Imported by: readmenator/_pipeline.py, tests/test_layer_rules.py

readmenator/_layers.py

Depends on: readmenator/_models.py Imported by: readmenator/_app.py, readmenator/_cursorrules_generator.py, readmenator/_linter.py, readmenator/_mcp_server.py, readmenator/_pipeline.py, tests/test_agent_friendliness.py

  • LayerDetector.detect (method) readmenator/_layers.py:83 def detect(self, nodes, edges) -- Assign each file node to an architectural layer.
  • LayerDetector.layer_summary (method) readmenator/_layers.py:189 def layer_summary(layers) -- Count files per layer.

readmenator/_linter.py

Depends on: readmenator/_config.py, readmenator/_layers.py, readmenator/_models.py Imported by: readmenator/_app.py, tests/test_linter.py

  • ArchitectureLinter.__init__ (method) readmenator/_linter.py:31 def __init__(self, config)
  • ArchitectureLinter.lint (method) readmenator/_linter.py:34 def lint(self, nodes, edges, resolved_edges, layers, content_map) -- Run all linter rules and return violations.

readmenator/_mcp_server.py

Depends on: readmenator/_app.py, readmenator/_config.py, readmenator/_layers.py, readmenator/_query.py Imported by: readmenator/__init__.py, readmenator/__main__.py, tests/test_mcp_server.py

readmenator/_memory.py

Depends on: readmenator/_config.py, readmenator/_gitmeta.py, readmenator/_models.py, readmenator/_purpose.py Imported by: readmenator/_pipeline.py, tests/test_memory.py

  • MemoryNote.sanitize_note (method) readmenator/_memory.py:84 def sanitize_note(text, max_chars) -- Collapse a note to one safe line that cannot break the preserved block.
  • ProjectMemory.__init__ (method) readmenator/_memory.py:105 def __init__(self, config) -- Initialise with application configuration.
  • ProjectMemory.path (method) readmenator/_memory.py:113 def path(self, project_root) -- Return the MEMORY.md location for a project root.
  • ProjectMemory.read (method) readmenator/_memory.py:117 def read(self, project_root) -- Return the current memory file text ("" when missing).
  • ProjectMemory.notes (method) readmenator/_memory.py:124 def notes(self, project_root) -- Parse the preserved session log into notes.
  • ProjectMemory.remember (method) readmenator/_memory.py:149 def remember(self, project_root, note, kind, today) -- Append one note to the preserved session log.
  • ProjectMemory.write (method) readmenator/_memory.py:218 def write(self, project_root, generated) -- Write generated sections while preserving the existing session log.
  • ProjectMemory.build (method) readmenator/_memory.py:231 def build(self, project_root, nodes, analysis, analysis_v2, findings, concept_graph, content_map) -- Render the generated memory document (with an empty notes block).
  • ProjectMemory.extract_rules (method) readmenator/_memory.py:291 def extract_rules(self, project_root) -- Extract categorised rule lines from the project's instruction files.
  • ProjectMemory.detect_commands (method) readmenator/_memory.py:419 def detect_commands(self, root, nodes) -- Detect workflow commands from project manifests.

readmenator/_mermaid.py

Depends on: readmenator/_models.py Imported by: readmenator/_documentation.py, tests/test_mermaid.py

  • MermaidRenderer.__init__ (method) readmenator/_mermaid.py:26 def __init__(self, max_nodes, max_symbols_per_file, module_style, class_style, function_style, external_style...
  • MermaidRenderer.render (method) readmenator/_mermaid.py:56 def render(self, nodes, edges, resolved_edges, analysis) -- Produce a Mermaid flowchart string and a truncation flag.

readmenator/_models.py

Depends on: readmenator/_category.py Imported by: readmenator/__init__.py, readmenator/_agent_output.py, readmenator/_analytics.py, readmenator/_analyzer.py, readmenator/_app.py, readmenator/_concepts.py, readmenator/_cpg.py, readmenator/_cursorrules_generator.py, readmenator/_dataflow.py, readmenator/_dead_code.py, readmenator/_diagrams.py, readmenator/_documentation.py, readmenator/_explorer.py, readmenator/_exporter.py, readmenator/_forcegraph.py, readmenator/_graphrag.py, readmenator/_hotspots.py, readmenator/_layer_rules.py, readmenator/_layers.py, readmenator/_linter.py, readmenator/_memory.py, readmenator/_mermaid.py, readmenator/_pipeline.py, readmenator/_projections.py, readmenator/_provenance.py, readmenator/_purpose.py, readmenator/_query.py, readmenator/_refactorizer.py, readmenator/_rule_gen.py, readmenator/_sarif.py, readmenator/_scanner.py, readmenator/_scantext.py, readmenator/_security.py, readmenator/_taint.py, readmenator/_uml.py, readmenator/_video.py, readmenator/_wiki.py, readmenator/parsers/_assembly.py, readmenator/parsers/_base.py, readmenator/parsers/_c.py, readmenator/parsers/_csharp.py, readmenator/parsers/_dart.py, readmenator/parsers/_elixir.py, readmenator/parsers/_gdscript.py, readmenator/parsers/_go.py, readmenator/parsers/_java.py, readmenator/parsers/_javascript.py, readmenator/parsers/_kotlin.py, readmenator/parsers/_lua.py, readmenator/parsers/_nim.py, readmenator/parsers/_php.py, readmenator/parsers/_python.py, readmenator/parsers/_ruby.py, readmenator/parsers/_rust.py, readmenator/parsers/_scala.py, readmenator/parsers/_shell.py, readmenator/parsers/_swift.py, tests/test_agent_friendliness.py, tests/test_agent_output.py, tests/test_analyzer.py, tests/test_bundlegraph.py, tests/test_concepts.py, tests/test_cpg.py, tests/test_cursorrules.py, tests/test_dataflow.py, tests/test_dead_code.py, tests/test_diagrams.py, tests/test_documentation.py, tests/test_exporter.py, tests/test_graphrag.py, tests/test_hotspots.py, tests/test_interactive_graph.py, tests/test_layer_rules.py, tests/test_linter.py, tests/test_memory.py, tests/test_mermaid.py, tests/test_models.py, tests/test_parsers_property.py, tests/test_query.py, tests/test_ranking.py, tests/test_refactorizer.py, tests/test_rule_gen.py, tests/test_sarif.py, tests/test_scanner.py, tests/test_security.py, tests/test_taint.py, tests/test_taint_bdd.py, tests/test_uml.py, tests/test_video.py, tests/test_wiki.py

  • SecurityFinding.pluralize_symbol_kind (method) readmenator/_models.py:101 def pluralize_symbol_kind(kind, plural_map) -- Return the plural form of kind according to plural_map.

readmenator/_pipeline.py

Depends on: readmenator/_agent_injector.py, readmenator/_agent_output.py, readmenator/_analytics.py, readmenator/_analyzer.py, readmenator/_bundlegraph.py, readmenator/_category.py, readmenator/_concepts.py, readmenator/_config.py, readmenator/_cpg.py, readmenator/_dataflow.py, readmenator/_diagrams.py, readmenator/_documentation.py, readmenator/_embed.py, readmenator/_exclusions.py, readmenator/_exporter.py, readmenator/_forcegraph.py, readmenator/_gh_wiki.py, readmenator/_graphrag.py, readmenator/_hotspots.py, readmenator/_layer_rules.py, readmenator/_layers.py, readmenator/_memory.py, readmenator/_models.py, readmenator/_provenance.py, readmenator/_rank.py, readmenator/_readme_injector.py, readmenator/_rule_gen.py, readmenator/_sarif.py, readmenator/_scanner.py, readmenator/_scantext.py, readmenator/_security.py, readmenator/_skill_installer.py, readmenator/_taint.py, readmenator/_uml.py, readmenator/_video.py, readmenator/_wiki.py Imported by: readmenator/_app.py

readmenator/_projections.py

Depends on: readmenator/_category.py, readmenator/_models.py Imported by: tests/test_ranking.py

readmenator/_provenance.py

Depends on: readmenator/_config.py, readmenator/_models.py Imported by: readmenator/_pipeline.py, tests/test_interactive_graph.py

  • ProvenanceFinding.is_inferred_only (method) readmenator/_provenance.py:32 def is_inferred_only(self) -- Return True when no static evidence supports the finding.
  • ProvenanceFinding.reading (method) readmenator/_provenance.py:37 def reading(self) -- Explain which way an inferred-only hit points.
  • ProvenanceAuditor.__init__ (method) readmenator/_provenance.py:49 def __init__(self, config) -- Initialise with application configuration.
  • ProvenanceAuditor.audit (method) readmenator/_provenance.py:57 def audit(self, findings, content_map) -- Audit findings for evidence provenance.
  • ProvenanceAuditor.summary (method) readmenator/_provenance.py:98 def summary(self, findings) -- Summarize provenance findings by provenance class.

readmenator/_purpose.py

Depends on: readmenator/_models.py Imported by: readmenator/_agent_output.py, readmenator/_forcegraph.py, readmenator/_graphrag.py, readmenator/_memory.py, readmenator/_wiki.py, tests/test_agent_friendliness.py

  • is_garbage_doc (function) readmenator/_purpose.py:26 def is_garbage_doc(text) -- Return True for doc lines that carry no purpose signal.
  • clean_purpose (function) readmenator/_purpose.py:43 def clean_purpose(text) -- Return the purpose signal of a doc first line, or an empty string.
  • escape_cell (function) readmenator/_purpose.py:66 def escape_cell(text) -- Escape markdown table breaking characters in one line of text.
  • truncate_words (function) readmenator/_purpose.py:78 def truncate_words(text, max_chars) -- Truncate text at a word boundary and mark the cut with an ellipsis.
  • first_sentence (function) readmenator/_purpose.py:98 def first_sentence(doc) -- Return the first clean sentence of the first meaningful paragraph.
  • file_purpose (function) readmenator/_purpose.py:140 def file_purpose(node, max_chars) -- Return a bounded one-sentence purpose for a file node.

readmenator/_query.py

Depends on: readmenator/_category.py, readmenator/_models.py, readmenator/_rank.py Imported by: readmenator/_app.py, readmenator/_mcp_server.py, tests/test_query.py

  • QueryEngine.__init__ (method) readmenator/_query.py:34 def __init__(self, nodes, edges, resolved_edges, ranker, config) -- Initialise internal indexes from scanned data.
  • QueryEngine.ranked_query (method) readmenator/_query.py:73 def ranked_query(self, query, top_n) -- Answer query with a ranked list of relevant nodes.
  • QueryEngine.find_symbol (method) readmenator/_query.py:220 def find_symbol(self, name) -- Look up name by exact match, then by substring fuzzy match.
  • QueryEngine.explain (method) readmenator/_query.py:238 def explain(self, name) -- Return a detailed multi-line explanation of name.
  • QueryEngine.find_path (method) readmenator/_query.py:285 def find_path(self, symbol_a, symbol_b) -- Find the shortest import path from symbol_a to symbol_b.
  • QueryEngine.query (method) readmenator/_query.py:355 def query(self, question) -- Free-text search over symbols and file paths.
  • QueryEngine.summary (method) readmenator/_query.py:411 def summary(self) -- Return a concise overview of the loaded knowledge base.

Next: API_p2.md

Generated offline by readmenator from commit 0c608d6d6fa2. Edits here are overwritten by readmenator . --rebuild.

Start

Wiki

Agent Docs

Recipes

Clone this wiki locally