Agent API

API

readmenator/main.py

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

• build_parser (function) readmenator/__main__.py:18 def build_parser()
• main (function) readmenator/__main__.py:134 def main()

readmenator/_agent_injector.py

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

• ensure_readmenator_installed (function) readmenator/_agent_injector.py:101 def ensure_readmenator_installed() -- Check if readmenator is installed via pip; install it if missing.
• AgentInjector.__init__ (method) readmenator/_agent_injector.py:134 def __init__(self, kb_filename, agent_output_dir, agent_files, agent_globs, wiki_output_dir)
• AgentInjector.inject (method) readmenator/_agent_injector.py:148 def inject(self, project_root) -- Inject KB reference into all discovered agent files.
• AgentInjector.remove (method) readmenator/_agent_injector.py:166 def remove(self, project_root) -- Remove KB injection from all discovered agent files.
• AgentInjector.find_agent_files (method) readmenator/_agent_injector.py:179 def find_agent_files(self, project_root) -- Public accessor: return all detected agent files.

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:523 def keep(file_id) -- Return whether a file belongs in the gotcha lists.

readmenator/_analyzer.py

Depends on: readmenator/_config.py, readmenator/_models.py Imported by: 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.

readmenator/_app.py

Depends on: readmenator/_cache.py, readmenator/_config.py, readmenator/_cursorrules_generator.py, readmenator/_dead_code.py, readmenator/_diagrams.py, readmenator/_gh_wiki.py, readmenator/_gitmeta.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 Imported by: readmenator/__init__.py, readmenator/__main__.py, readmenator/_mcp_server.py, tests/test_agent_friendliness.py, tests/test_diagrams.py, tests/test_gh_wiki.py, tests/test_integration.py, tests/test_mcp_server.py, tests/test_video.py

• readmenatorApplication.__init__ (method) readmenator/_app.py:45 def __init__(self, config)
• readmenatorApplication.run (method) readmenator/_app.py:91 def run(self, target_dir, resolve_imports, run_analysis, run_security, run_v2_analysis)
• readmenatorApplication.check_freshness (method) readmenator/_app.py:215 def check_freshness(self, target_dir) -- Compare the MANIFEST source fingerprint against the current sources.
• readmenatorApplication.publish_github_wiki (method) readmenator/_app.py:278 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:334 def generate_uml_code(self, target_dir, language, output_path)
• readmenatorApplication.update (method) readmenator/_app.py:401 def update(self, target_dir, run_security)
• readmenatorApplication.query (method) readmenator/_app.py:524 def query(self, target_dir, question)
• readmenatorApplication.explain (method) readmenator/_app.py:529 def explain(self, target_dir, symbol_name)
• readmenatorApplication.find_path (method) readmenator/_app.py:541 def find_path(self, target_dir, symbol_a, symbol_b)
• readmenatorApplication.summary (method) readmenator/_app.py:554 def summary(self, target_dir)
• readmenatorApplication.rank_query (method) readmenator/_app.py:559 def rank_query(self, target_dir, query, top_n) -- Run a ranked query against the knowledge graph.
• readmenatorApplication.rebuild (method) readmenator/_app.py:589 def rebuild(self, target_dir, run_security)
• readmenatorApplication.analyze (method) readmenator/_app.py:592 def analyze(self, target_dir)
• readmenatorApplication.export_json (method) readmenator/_app.py:596 def export_json(self, target_dir, output_path)
• readmenatorApplication.export_html (method) readmenator/_app.py:613 def export_html(self, target_dir, output_path)
• readmenatorApplication.export_svg (method) readmenator/_app.py:624 def export_svg(self, target_dir, output_path)
• readmenatorApplication.export (method) readmenator/_app.py:635 def export(self, target_dir)
• readmenatorApplication.export_graphml (method) readmenator/_app.py:640 def export_graphml(self, target_dir, output_path)
• readmenatorApplication.export_cypher (method) readmenator/_app.py:651 def export_cypher(self, target_dir, output_path)
• readmenatorApplication.export_obsidian (method) readmenator/_app.py:667 def export_obsidian(self, target_dir, output_dir)
• readmenatorApplication.export_wiki (method) readmenator/_app.py:682 def export_wiki(self, target_dir, output_dir) -- Generate the navigable agent wiki for the target project.
• readmenatorApplication.lint_wiki (method) readmenator/_app.py:705 def lint_wiki(self, target_dir) -- Check wiki health and log reported issues.
• readmenatorApplication.export_diagrams (method) readmenator/_app.py:723 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:784 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:823 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:858 def export_video(self, target_dir, output_path) -- Render the cinematic overview video for the target project.
• readmenatorApplication.watch (method) readmenator/_app.py:922 def watch(self, target_dir)
• readmenatorApplication.on_change (method) readmenator/_app.py:926 def on_change()
• readmenatorApplication.audit (method) readmenator/_app.py:932 def audit(self, target_dir)
• readmenatorApplication.audit_deep (method) readmenator/_app.py:939 def audit_deep(self, target_dir)
• readmenatorApplication.export_sarif (method) readmenator/_app.py:959 def export_sarif(self, target_dir, output_path)
• readmenatorApplication.export_rules (method) readmenator/_app.py:969 def export_rules(self, target_dir, output_dir)
• readmenatorApplication.detect_layers (method) readmenator/_app.py:979 def detect_layers(self, target_dir)
• readmenatorApplication.lint (method) readmenator/_app.py:989 def lint(self, target_dir)
• readmenatorApplication.strip_dead_code (method) readmenator/_app.py:1002 def strip_dead_code(self, target_dir)
• readmenatorApplication.generate_cursorrules (method) readmenator/_app.py:1012 def generate_cursorrules(self, target_dir)
• readmenatorApplication.refactor_monolith (method) readmenator/_app.py:1027 def refactor_monolith(self, target_dir)

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

• FileCache.__init__ (method) readmenator/_cache.py:31 def __init__(self, config, project_root)
• FileCache.load (method) readmenator/_cache.py:38 def load(self)
• FileCache.save (method) readmenator/_cache.py:49 def save(self, hashes)
• FileCache.compute_hash (method) readmenator/_cache.py:55 def compute_hash(self, file_path)
• FileCache.compute_hashes (method) readmenator/_cache.py:64 def compute_hashes(self, file_paths)
• FileCache.find_changed (method) readmenator/_cache.py:72 def find_changed(self, file_paths)
• FileCache.prune_deleted (method) readmenator/_cache.py:84 def prune_deleted(self, current_file_ids)
• FileCache.save_analysis (method) readmenator/_cache.py:95 def save_analysis(self, key, data) -- Save an analysis result to the semantic cache.
• FileCache.load_analysis (method) readmenator/_cache.py:118 def load_analysis(self, key) -- Load a previously cached analysis result.
• FileCache.clear_analysis (method) readmenator/_cache.py:135 def clear_analysis(self, key) -- Clear analysis cache, optionally for a specific key only.
• FileCache.has_changed_since_last_analysis (method) readmenator/_cache.py:166 def has_changed_since_last_analysis(self, file_paths) -- Check if any file has changed since the last analysis cache.
• FileCache.source_fingerprint (method) readmenator/_cache.py:179 def source_fingerprint(project_root, file_ids) -- Return one SHA256 over the sorted paths and contents of scanned sources.

readmenator/_category.py

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

• Morphism.weight (method) readmenator/_category.py:73 def weight(self) -- Effective weight for ranking = semantic weight * confidence.
• Category.__init__ (method) readmenator/_category.py:86 def __init__(self)
• Category.add_object (method) readmenator/_category.py:92 def add_object(self, obj_id)
• Category.add_morphism (method) readmenator/_category.py:95 def add_morphism(self, m)
• Category.objects (method) readmenator/_category.py:103 def objects(self)
• Category.morphisms (method) readmenator/_category.py:107 def morphisms(self)
• Category.outgoing (method) readmenator/_category.py:110 def outgoing(self, obj_id)
• Category.incoming (method) readmenator/_category.py:113 def incoming(self, obj_id)
• Category.compose (method) readmenator/_category.py:116 def compose(self, a, b) -- Compose two morphisms if target of a matches source of b.
• Category.paths (method) readmenator/_category.py:133 def paths(self, source, target, max_depth) -- Find all composition paths from source to target up to max_depth.
• Category.dfs (method) readmenator/_category.py:139 def dfs(current, goal, path, depth)
• TypedGraph.__init__ (method) readmenator/_category.py:188 def __init__(self, category)
• TypedGraph.nodes (method) readmenator/_category.py:203 def nodes(self)
• TypedGraph.size (method) readmenator/_category.py:207 def size(self)
• TypedGraph.node_index (method) readmenator/_category.py:210 def node_index(self, node_id)
• TypedGraph.transition_weight (method) readmenator/_category.py:213 def transition_weight(self, source, target) -- Sum of weights of all morphisms from source to target.
• TypedGraph.stochastic_row (method) readmenator/_category.py:221 def stochastic_row(self, source) -- Return dict of target -> probability for the row of source.
• TypedGraph.build_category_from_edges (method) readmenator/_category.py:236 def build_category_from_edges(edges, resolved_edges, node_ids) -- Build a Category from lists of Edge objects.

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

• CursorRulesGenerator.__init__ (method) readmenator/_cursorrules_generator.py:25 def __init__(self, config)
• CursorRulesGenerator.generate (method) readmenator/_cursorrules_generator.py:28 def generate(self, nodes, edges, analysis, layers, violations, project_root) -- Generate the .cursorrules content string.

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

• DeadCodeStripper.__init__ (method) readmenator/_dead_code.py:25 def __init__(self, config)
• DeadCodeStripper.identify (method) readmenator/_dead_code.py:28 def identify(self, nodes, edges, resolved_edges) -- Identify dead code symbols with zero in-degree.

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

• SystemMapValidator.__init__ (method) readmenator/_diagrams.py:214 def __init__(self, config) -- Initialise the validator with application configuration.
• SystemMapValidator.validate (method) readmenator/_diagrams.py:243 def validate(self, system_map) -- Validate a system map and return a deterministic receipt.
• SystemMapBuilder.__init__ (method) readmenator/_diagrams.py:464 def __init__(self, config) -- Initialise the builder with application configuration.
• SystemMapBuilder.supported_kinds (method) readmenator/_diagrams.py:473 def supported_kinds(self) -- Return the supported diagram kind identifiers.
• SystemMapBuilder.build (method) readmenator/_diagrams.py:494 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:553 def build_all(self, nodes, edges, resolved_edges, layers, findings, analysis, full) -- Build all five diagram kinds deterministically.
• SystemMapBuilder.compare (method) readmenator/_diagrams.py:584 def compare(self, base, head) -- Compare two maps of the same kind as before, delta, and after.
• InteractiveMapRenderer.__init__ (method) readmenator/_diagrams.py:1504 def __init__(self, config) -- Initialise the renderer with application configuration.
• InteractiveMapRenderer.render (method) readmenator/_diagrams.py:1533 def render(self, system_map) -- Render a system map as a self-contained HTML document.
• InteractiveMapRenderer.write (method) readmenator/_diagrams.py:1635 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:2224 def __init__(self, config) -- Initialise the renderer with application configuration.
• VisNetworkRenderer.render (method) readmenator/_diagrams.py:2232 def render(self, system_map) -- Render a system map as a vis.js network HTML document.
• VisNetworkRenderer.write (method) readmenator/_diagrams.py:2360 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:3009 def __init__(self, config) -- Initialise the publisher with application configuration.
• DocsSitePublisher.description_for (method) readmenator/_diagrams.py:3019 def description_for(self, kind) -- Return the gallery description for a diagram kind.
• DocsSitePublisher.publish (method) readmenator/_diagrams.py:3033 def publish(self, maps, project_name, output_dir, stats, renderer, project_root, video_rel, doc_entries) -- Publish maps and a gallery index into a documentation directory.
• DocsSitePublisher.collect_doc_sources (method) readmenator/_diagrams.py:3123 def collect_doc_sources(self, project_root) -- Collect generated markdown sources for the static site.
• DocsSitePublisher.publish_assets (method) readmenator/_diagrams.py:3149 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:3318 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:3366 def order(entry) -- Sort entry points first, then alphabetically.
• DocsSitePublisher.render_index (method) readmenator/_diagrams.py:3394 def render_index(self, project_name, maps, stats, href_prefix, video_rel, doc_entries, poster_rel) -- Render the gallery index page for published maps.
• DocsSitePublisher.doc_order (method) readmenator/_diagrams.py:3585 def doc_order(base) -- Entry points first, then alphabetical.

readmenator/_documentation.py

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

• DocumentationGenerator.__init__ (method) readmenator/_documentation.py:45 def __init__(self, config)
• DocumentationGenerator.generate (method) readmenator/_documentation.py:91 def generate(self, nodes, edges, resolved_edges, analysis, layers, findings, analysis_v2, ranked)

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/_exporter.py

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

• GraphExporter.__init__ (method) readmenator/_exporter.py:35 def __init__(self, config) -- Initialise with application configuration.
• GraphExporter.to_json (method) readmenator/_exporter.py:43 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:182 def to_html(self, nodes, edges, resolved_edges, analysis, findings) -- Generate a standalone interactive HTML graph page.
• GraphExporter.to_svg (method) readmenator/_exporter.py:468 def to_svg(self, nodes, edges, resolved_edges, analysis) -- Generate a static SVG representation of the graph.
• GraphExporter.to_graphml (method) readmenator/_exporter.py:682 def to_graphml(self, nodes, edges, resolved_edges, analysis) -- Export the graph as GraphML (Gephi/yEd compatible).
• GraphExporter.to_cypher (method) readmenator/_exporter.py:759 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:881 def to_obsidian(self, nodes, edges, output_dir, analysis, concept_graph) -- Export the graph as an Obsidian vault with wikilinks.

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, 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/_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

• LayerRuleEngine.__init__ (method) readmenator/_layer_rules.py:36 def __init__(self, config)
• LayerRuleEngine.detect_violations (method) readmenator/_layer_rules.py:39 def detect_violations(self, nodes, edges, resolved_edges, layers) -- Detect architectural layer violations.
• LayerRuleEngine.violation_summary (method) readmenator/_layer_rules.py:111 def violation_summary(violations) -- Summarise violations by severity.

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/_models.py, readmenator/_query.py Imported by: readmenator/__init__.py, readmenator/__main__.py, tests/test_mcp_server.py

• MCPError.__init__ (method) readmenator/_mcp_server.py:59 def __init__(self, code, message, data)
• MCPRequest.__init__ (method) readmenator/_mcp_server.py:72 def __init__(self, msg)
• MCPRequest.is_notification (method) readmenator/_mcp_server.py:79 def is_notification(self)
• MCPRequest.response (method) readmenator/_mcp_server.py:82 def response(self, result)
• MCPRequest.error (method) readmenator/_mcp_server.py:85 def error(self, code, message, data)
• MCPTool.__init__ (method) readmenator/_mcp_server.py:93 def __init__(self, name, description, handler, input_schema)
• MCPTool.definition (method) readmenator/_mcp_server.py:108 def definition(self)
• MCPTool.call (method) readmenator/_mcp_server.py:115 def call(self, arguments)
• MCPResource.__init__ (method) readmenator/_mcp_server.py:120 def __init__(self, uri, name, description, mime_type, handler)
• MCPResource.definition (method) readmenator/_mcp_server.py:134 def definition(self)
• MCPResource.read (method) readmenator/_mcp_server.py:142 def read(self)
• MCPServer.__init__ (method) readmenator/_mcp_server.py:147 def __init__(self, app, target_dir)
• MCPServer.register_tool (method) readmenator/_mcp_server.py:155 def register_tool(self, tool)
• MCPServer.register_resource (method) readmenator/_mcp_server.py:158 def register_resource(self, resource)
• MCPServer.dispatch (method) readmenator/_mcp_server.py:241 def dispatch(self, req)
• MCPServer.run (method) readmenator/_mcp_server.py:261 def run(self)
• MCPServer.main (method) readmenator/_mcp_server.py:864 def main() -- CLI entry point for readmenator serve <path>.

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/_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/_exporter.py, readmenator/_hotspots.py, readmenator/_layer_rules.py, readmenator/_layers.py, readmenator/_linter.py, readmenator/_mcp_server.py, readmenator/_mermaid.py, readmenator/_pipeline.py, readmenator/_projections.py, readmenator/_purpose.py, readmenator/_query.py, readmenator/_refactorizer.py, readmenator/_rule_gen.py, readmenator/_sarif.py, readmenator/_scanner.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_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_hotspots.py, tests/test_layer_rules.py, tests/test_linter.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/_analyzer.py, readmenator/_category.py, readmenator/_concepts.py, readmenator/_config.py, readmenator/_cpg.py, readmenator/_dataflow.py, readmenator/_diagrams.py, readmenator/_documentation.py, readmenator/_exporter.py, readmenator/_gh_wiki.py, readmenator/_hotspots.py, readmenator/_layer_rules.py, readmenator/_layers.py, readmenator/_models.py, readmenator/_rank.py, readmenator/_readme_injector.py, readmenator/_rule_gen.py, readmenator/_sarif.py, readmenator/_scanner.py, readmenator/_security.py, readmenator/_taint.py, readmenator/_uml.py, readmenator/_video.py, readmenator/_wiki.py Imported by: readmenator/_app.py

• AnalyzerFactory.__init__ (method) readmenator/_pipeline.py:58 def __init__(self, config)
• AnalyzerFactory.scanner (method) readmenator/_pipeline.py:90 def scanner(self)
• AnalyzerFactory.generator (method) readmenator/_pipeline.py:96 def generator(self)
• AnalyzerFactory.analyzer (method) readmenator/_pipeline.py:102 def analyzer(self)
• AnalyzerFactory.security (method) readmenator/_pipeline.py:108 def security(self)
• AnalyzerFactory.exporter (method) readmenator/_pipeline.py:114 def exporter(self)
• AnalyzerFactory.taint (method) readmenator/_pipeline.py:120 def taint(self)
• AnalyzerFactory.dataflow (method) readmenator/_pipeline.py:126 def dataflow(self) -- Return the lazily initialised dataflow analyzer.
• AnalyzerFactory.hotspots (method) readmenator/_pipeline.py:133 def hotspots(self)
• AnalyzerFactory.layer_rules (method) readmenator/_pipeline.py:139 def layer_rules(self)
• AnalyzerFactory.rule_gen (method) readmenator/_pipeline.py:145 def rule_gen(self)
• AnalyzerFactory.sarif (method) readmenator/_pipeline.py:151 def sarif(self)
• AnalyzerFactory.cpg (method) readmenator/_pipeline.py:157 def cpg(self)
• AnalyzerFactory.layer_detector (method) readmenator/_pipeline.py:166 def layer_detector(self)
• AnalyzerFactory.uml (method) readmenator/_pipeline.py:172 def uml(self)
• AnalyzerFactory.wiki (method) readmenator/_pipeline.py:178 def wiki(self) -- Return the lazily initialised agent wiki generator.
• AnalyzerFactory.readme_injector (method) readmenator/_pipeline.py:185 def readme_injector(self)
• AnalyzerFactory.agent_injector (method) readmenator/_pipeline.py:195 def agent_injector(self)
• AnalyzerFactory.gh_wiki (method) readmenator/_pipeline.py:205 def gh_wiki(self) -- Return the lazily initialised GitHub wiki publisher.
• AnalyzerFactory.agent_output (method) readmenator/_pipeline.py:212 def agent_output(self)
• AnalyzerFactory.diagram_builder (method) readmenator/_pipeline.py:218 def diagram_builder(self) -- Return the lazily initialised system map builder.
• AnalyzerFactory.diagram_renderer (method) readmenator/_pipeline.py:225 def diagram_renderer(self) -- Return the lazily initialised interactive map renderer.
• AnalyzerFactory.diagram_validator (method) readmenator/_pipeline.py:232 def diagram_validator(self) -- Return the lazily initialised system map validator.
• AnalyzerFactory.diagram_publisher (method) readmenator/_pipeline.py:239 def diagram_publisher(self) -- Return the lazily initialised documentation site publisher.
• AnalyzerFactory.vis_renderer (method) readmenator/_pipeline.py:246 def vis_renderer(self) -- Return the lazily initialised vis.js network renderer.
• AnalyzerFactory.video (method) readmenator/_pipeline.py:253 def video(self) -- Return the lazily initialised cinematic video renderer.
• AnalyzerFactory.concepts (method) readmenator/_pipeline.py:260 def concepts(self) -- Return the lazily initialised semantic concept extractor.
• AnalyzerFactory.build_typed_graph (method) readmenator/_pipeline.py:266 def build_typed_graph(self, nodes, edges, resolved_edges)
• AnalyzerFactory.make_ranker (method) readmenator/_pipeline.py:276 def make_ranker(self, typed_graph) -- Create a CompositeRanker for the given typed graph.
• AnalyzerFactory.last_category (method) readmenator/_pipeline.py:293 def last_category(self)
• AnalyzerFactory.last_typed_graph (method) readmenator/_pipeline.py:297 def last_typed_graph(self)
• DeepAnalysisRunner.__init__ (method) readmenator/_pipeline.py:310 def __init__(self, factory)
• DeepAnalysisRunner.run (method) readmenator/_pipeline.py:313 def run(self, nodes, edges, resolved_edges, layers, content_map)

readmenator/_projections.py

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

• Projection.map_node (method) readmenator/_projections.py:23 def map_node(self, node) -- Map a code node.
• Projection.map_morphism (method) readmenator/_projections.py:27 def map_morphism(self, m) -- Map a morphism.
• IdentityProjection.map_node (method) readmenator/_projections.py:35 def map_node(self, node)
• IdentityProjection.map_morphism (method) readmenator/_projections.py:38 def map_morphism(self, m)
• DocProjection.__init__ (method) readmenator/_projections.py:49 def __init__(self, documented_ids)
• DocProjection.map_node (method) readmenator/_projections.py:52 def map_node(self, node)
• DocProjection.map_morphism (method) readmenator/_projections.py:57 def map_morphism(self, m)
• RiskProjection.__init__ (method) readmenator/_projections.py:70 def __init__(self, fan_in, fan_out, test_files)
• RiskProjection.map_node (method) readmenator/_projections.py:80 def map_node(self, node)
• RiskProjection.map_morphism (method) readmenator/_projections.py:91 def map_morphism(self, m)
• RiskProjection.apply_view (method) readmenator/_projections.py:95 def apply_view(category, view_config) -- Apply a named view to produce a projected category.

readmenator/_purpose.py

Depends on: readmenator/_models.py Imported by: readmenator/_agent_output.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.

readmenator/_rank.py

Depends on: readmenator/_category.py Imported by: readmenator/__init__.py, readmenator/_app.py, readmenator/_documentation.py, readmenator/_explain.py, readmenator/_pipeline.py, readmenator/_query.py, tests/test_ranking.py

• RankConfig.global_pagerank (method) readmenator/_rank.py:61 def global_pagerank(graph, alpha, max_iter, tolerance) -- Compute global PageRank on the typed weighted graph.
• RankConfig.personalized_pagerank (method) readmenator/_rank.py:119 def personalized_pagerank(graph, seeds, alpha, max_iter, tolerance) -- Compute Personalized PageRank with a seed-node preference vector.
• RankConfig.hits (method) readmenator/_rank.py:189 def hits(graph, max_iter, tolerance) -- Compute HITS (Hyperlink-Induced Topic Search) authorities and hubs.
• RankConfig.build_seeds_from_query (method) readmenator/_rank.py:240 def build_seeds_from_query(query, node_ids, node_labels, symbols) -- Build a PPR seed vector from a natural-language query string.
• RankConfig.build_seeds_for_context (method) readmenator/_rank.py:286 def build_seeds_for_context(node_ids, anchor_patterns) -- Build a PPR seed vector from anchor pattern strings.
• RankedItem.label (method) readmenator/_rank.py:344 def label(self)
• RankedResult.top (method) readmenator/_rank.py:366 def top(self, n)
• RankedResult.explain (method) readmenator/_rank.py:369 def explain(self, node_id) -- Return a human-readable explanation of why node_id ranks as it does.
• CompositeRanker.__init__ (method) readmenator/_rank.py:385 def __init__(self, graph, config)
• CompositeRanker.rank (method) readmenator/_rank.py:404 def rank(self, query, seeds, category, node_ids, test_coverage, doc_coverage, freshness) -- Compute composite ranking for a query.

readmenator/_readme_injector.py

Imported by: readmenator/__init__.py, readmenator/_pipeline.py, tests/test_agent_output.py, tests/test_readme_injector.py

• ReadmeInjector.__init__ (method) readmenator/_readme_injector.py:78 def __init__(self, kb_filename, agent_output_dir, wiki_output_dir)
• ReadmeInjector.inject (method) readmenator/_readme_injector.py:88 def inject(self, project_root)
• ReadmeInjector.remove (method) readmenator/_readme_injector.py:136 def remove(self, project_root)

readmenator/_refactorizer.py

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

• MonolithRefactorizer.__init__ (method) readmenator/_refactorizer.py:32 def __init__(self, config)
• MonolithRefactorizer.analyze (method) readmenator/_refactorizer.py:35 def analyze(self, nodes, edges, resolved_edges, content_map) -- Identify monolithic files and generate refactoring plans.
• MonolithRefactorizer.generate_script (method) readmenator/_refactorizer.py:156 def generate_script(self, plan, project_root)

readmenator/_resolver.py

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

• ImportResolver.__init__ (method) readmenator/_resolver.py:61 def __init__(self, file_ids, root, extensions, include_dirs) -- Initialise the resolver with all known file paths.
• ImportResolver.resolve (method) readmenator/_resolver.py:110 def resolve(self, import_str, source_file) -- Resolve an import string to a concrete project file path.
• ImportResolver.resolve_all (method) readmenator/_resolver.py:163 def resolve_all(self, import_str, source_file) -- Resolve import_str to all possible matching project file paths.

readmenator/_rule_gen.py

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

• RuleGenerator.__init__ (method) readmenator/_rule_gen.py:90 def __init__(self, config)
• RuleGenerator.generate (method) readmenator/_rule_gen.py:94 def generate(self, nodes, content_map) -- Generate suggested rules by scanning code patterns.
• RuleGenerator.write_rules (method) readmenator/_rule_gen.py:122 def write_rules(self, rules, output_dir) -- Write suggested rules to Semgrep YAML files in output_dir.

readmenator/_sarif.py

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

• SarifExporter.__init__ (method) readmenator/_sarif.py:30 def __init__(self, privacy_mode)
• SarifExporter.export (method) readmenator/_sarif.py:33 def export(self, findings, project_name) -- Generate a SARIF v2.1.0 JSON string from security findings.

readmenator/_scanner.py

Depends on: readmenator/_config.py, readmenator/_models.py, readmenator/parsers/__init__.py Imported by: readmenator/_pipeline.py, tests/test_agent_friendliness.py, tests/test_scanner.py, tests/test_taint_bdd.py

• PolyglotScanner.__init__ (method) readmenator/_scanner.py:39 def __init__(self, config) -- Initialise the scanner with application configuration.
• PolyglotScanner.scan (method) readmenator/_scanner.py:261 def scan(self, root) -- Walk root recursively and produce (nodes, edges) for the graph.
• PolyglotScanner.scan_with_content (method) readmenator/_scanner.py:275 def scan_with_content(self, root) -- Scan and also return raw file contents for deeper analysis.

readmenator/_security.py

Depends on: readmenator/_config.py, readmenator/_models.py Imported by: readmenator/_agent_output.py, readmenator/_pipeline.py, readmenator/_wiki.py, tests/test_security.py

• SecurityAnalyzer.__init__ (method) readmenator/_security.py:496 def __init__(self, config)
• SecurityAnalyzer.scan (method) readmenator/_security.py:513 def scan(self, root)
• SecurityAnalyzer.summary (method) readmenator/_security.py:572 def summary(self, findings)
• SecurityAnalyzer.fix_hint_for (method) readmenator/_security.py:620 def fix_hint_for(finding) -- Return a one-line remediation hint for a security finding.

readmenator/_taint.py

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

• TaintAnalyzer.__init__ (method) readmenator/_taint.py:73 def __init__(self, config)
• TaintAnalyzer.analyze (method) readmenator/_taint.py:77 def analyze(self, nodes, edges, resolved_edges) -- Run taint propagation analysis on the codebase.

readmenator/_uml.py

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

• UmlGenerator.__init__ (method) readmenator/_uml.py:36 def __init__(self, config)
• UmlGenerator.render_mermaid_class_diagram (method) readmenator/_uml.py:39 def render_mermaid_class_diagram(self, nodes, edges)
• UmlGenerator.generate_code (method) readmenator/_uml.py:129 def generate_code(self, nodes, edges, target_language)

readmenator/_video.py

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

• ease (function) readmenator/_video.py:73 def ease(x) -- Smoothstep clamped to [0, 1].
• fmt_int (function) readmenator/_video.py:79 def fmt_int(n) -- Group thousands with commas.
• mix (function) readmenator/_video.py:84 def mix(a, b, t) -- Linear blend of two RGB colors.
• alpha (function) readmenator/_video.py:89 def alpha(c, a) -- RGB color plus an alpha in [0, 1] as an RGBA tuple.
• hash_color (function) readmenator/_video.py:94 def hash_color(digest) -- Neon color derived from a digest: the file fingerprint.
• short_label (function) readmenator/_video.py:103 def short_label(text, limit) -- Truncate a label to a character budget without newlines.
• dependencies_available (function) readmenator/_video.py:188 def dependencies_available() -- Check that PIL and ffmpeg exist for video rendering.
• resolve_fonts (function) readmenator/_video.py:197 def resolve_fonts() -- Resolve monospace fonts through fontconfig with PIL fallback.
• Backdrop.__init__ (method) readmenator/_video.py:239 def __init__(self, width, height) -- Build the gradient sky, star field, sun and CRT mask.
• Backdrop.draw_grid (method) readmenator/_video.py:299 def draw_grid(img, t, strength, bd) -- Draw the scrolling perspective grid below the horizon.
• Backdrop.draw_sun (method) readmenator/_video.py:319 def draw_sun(img, a, bd, cy) -- Paste the striped synthwave sun behind the horizon.
• Backdrop.post (method) readmenator/_video.py:336 def post(img, glitch, seed) -- Apply bloom, scanlines, vignette and optional glitch.
• Backdrop.glitch_fx (method) readmenator/_video.py:354 def glitch_fx(img, amount, seed) -- RGB split plus horizontal slice displacement.
• Backdrop.chroma_text (method) readmenator/_video.py:377 def chroma_text(img, xy, text, font, col, spread, anchor) -- Draw text with red/cyan CRT chromatic aberration.
• Backdrop.hud_panel (method) readmenator/_video.py:388 def hud_panel(d, box, title, fonts, col) -- Draw a translucent HUD panel with neon edge and corner brackets.
• Backdrop.draw_header (method) readmenator/_video.py:401 def draw_header(img, d, gt, total, project, act_label, fonts, width) -- Draw the top strip with project title, act label and progress.
• Backdrop.draw_caption (method) readmenator/_video.py:415 def draw_caption(d, text, lt, dur, fonts, width, y) -- Draw the lower-third narration line with typing effect.
• CinematicVideoRenderer.collect (method) readmenator/_video.py:436 def collect(self, nodes, edges, resolved_edges, analysis, layers, findings, analysis_v2, project_name, content_map... -- Collect every number each scene draws, from real scan data.
• CinematicVideoRenderer.build_scenes (method) readmenator/_video.py:637 def build_scenes(self, data) -- Lay every scene on the global clock.
• CinematicVideoRenderer.graph_positions (method) readmenator/_video.py:663 def graph_positions(self, data, box) -- Compute deterministic positions for graph nodes inside a box.
• CinematicVideoRenderer.tree_positions (method) readmenator/_video.py:710 def tree_positions(self, data, box) -- Place the full BFS tree radially: root in the center, one ring per depth.
• CinematicVideoRenderer.render_single_frame (method) readmenator/_video.py:753 def render_single_frame(self, data, frame_index) -- Render one frame to raw RGB bytes without touching ffmpeg.
• CinematicVideoRenderer.render (method) readmenator/_video.py:771 def render(self, data, output_path) -- Render all frames and encode to mp4, muxing music if configured.

readmenator/_watcher.py

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

• DirectoryWatcher.__init__ (method) readmenator/_watcher.py:29 def __init__(self, root, config, callback, interval_seconds) -- Initialise the watcher for a project root.
• DirectoryWatcher.start (method) readmenator/_watcher.py:80 def start(self) -- Start watching the directory (blocking).
• DirectoryWatcher.stop (method) readmenator/_watcher.py:97 def stop(self) -- Stop watching.

readmenator/_wiki.py

Depends on: readmenator/_analyzer.py, readmenator/_config.py, readmenator/_models.py, readmenator/_purpose.py, readmenator/_security.py Imported by: readmenator/_pipeline.py, tests/test_wiki.py

• existing_ids (function) readmenator/_wiki.py:62 def existing_ids(connections) -- Return community id pairs already linked, to avoid duplicate edges.
• WikiGenerator.__init__ (method) readmenator/_wiki.py:89 def __init__(self, config) -- Store configuration for wiki output limits and paths.
• WikiGenerator.generate (method) readmenator/_wiki.py:94 def generate(self, nodes, edges, resolved_edges, analysis, layers, findings, analysis_v2, project_root) -- Write all wiki files and return the output directory path.
• WikiGenerator.lint (method) readmenator/_wiki.py:219 def lint(self, project_root) -- Check wiki health and return a list of issue descriptions.
• WikiGenerator.dominant (method) readmenator/_wiki.py:428 def dominant(ids, key)

readmenator/parsers/init.py

Depends on: readmenator/_config.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 Imported by: readmenator/_scanner.py, tests/test_parsers.py, tests/test_parsers_new.py

• create_parser (function) readmenator/parsers/__init__.py:70 def create_parser(extension, filename, config) -- Factory: return a parser instance for the given file extension.

readmenator/parsers/_base.py

Depends on: readmenator/_config.py, readmenator/_models.py Imported by: readmenator/parsers/__init__.py, readmenator/parsers/_assembly.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

• LanguageParser.__init__ (method) readmenator/parsers/_base.py:21 def __init__(self, filename, config) -- Initialise the parser with a file path and application config.
• LanguageParser.parse (method) readmenator/parsers/_base.py:36 def parse(self, content) -- Parse content and populate symbol/import lists.

readmenator_orchestrator.py

• GitHubClient.__init__ (method) readmenator_orchestrator.py:78 def __init__(self, config)
• GitHubClient.list_repos (method) readmenator_orchestrator.py:118 def list_repos(self)
• GitHubClient.close_existing_prs (method) readmenator_orchestrator.py:130 def close_existing_prs(self, repo)
• GitHubClient.delete_remote_branch (method) readmenator_orchestrator.py:158 def delete_remote_branch(self, repo)
• GitHubClient.create_pr (method) readmenator_orchestrator.py:170 def create_pr(self, repo, default_branch, timestamp)
• RepositoryProcessor.__init__ (method) readmenator_orchestrator.py:192 def __init__(self, config, github_client)
• RepositoryProcessor.process (method) readmenator_orchestrator.py:196 def process(self, repo)
• Orchestrator.__init__ (method) readmenator_orchestrator.py:342 def __init__(self, config)
• Orchestrator.run (method) readmenator_orchestrator.py:347 def run(self, dry_run, only_repo)
• TestOrchestrator.setUp (method) readmenator_orchestrator.py:397 def setUp(self)
• TestOrchestrator.tearDown (method) readmenator_orchestrator.py:401 def tearDown(self)
• TestOrchestrator.test_config_immutability (method) readmenator_orchestrator.py:404 def test_config_immutability(self)
• TestOrchestrator.test_config_defaults (method) readmenator_orchestrator.py:408 def test_config_defaults(self)
• TestOrchestrator.test_skip_repos_logic (method) readmenator_orchestrator.py:415 def test_skip_repos_logic(self)
• TestOrchestrator.test_repo_name_validation (method) readmenator_orchestrator.py:419 def test_repo_name_validation(self)
• TestOrchestrator.test_branch_name_validation (method) readmenator_orchestrator.py:429 def test_branch_name_validation(self)
• TestOrchestrator.parse_arguments (method) readmenator_orchestrator.py:438 def parse_arguments()
• TestOrchestrator.main (method) readmenator_orchestrator.py:455 def main()