Repository navigation
community_4_readmenator_pipeline
grisun0 edited this page Oct 16, 2026
·
7 revisions
Community 4 | 17 files | cohesion 0.26
This community groups 17 file(s) rooted at readmenator with dominant language py (cohesion 0.26). Central symbols: AgentInjector, AnalyticsBuilder, AnalyzerFactory, CodePropertyGraph, DeepAnalysisRunner, DocumentationGenerator, Embedder, ExclusionEntry. Core file: tests/test_interactive_graph.py (60 symbols). Documented purpose: Injects KNOWLEDGE_BASE.md references into AI agent instruction files. Detects common AI agent configuration files (AGENTS.md, CLAUDE.md, .cursorrules, etc.) an.
| File | Language | Layer | Symbols | Doc |
|---|---|---|---|---|
readmenator/_agent_injector.py |
py | infrastructure | 14 | yes |
readmenator/_analytics.py |
py | utility | 9 | yes |
readmenator/_cpg.py |
py | utility | 6 | yes |
readmenator/_documentation.py |
py | utility | 31 | yes |
readmenator/_embed.py |
py | utility | 11 | yes |
readmenator/_exclusions.py |
py | utility | 11 | yes |
readmenator/_explorer.py |
py | utility | 14 | yes |
readmenator/_exporter.py |
py | utility | 16 | yes |
readmenator/_pipeline.py |
py | utility | 53 | yes |
readmenator/_provenance.py |
py | utility | 10 | yes |
readmenator/_readme_injector.py |
py | infrastructure | 9 | yes |
readmenator/_scantext.py |
py | utility | 4 | yes |
readmenator/_uml.py |
py | utility | 25 | yes |
tests/test_agent_injector.py |
py | testing | 38 | yes |
tests/test_agent_output.py |
py | testing | 45 | no |
tests/test_interactive_graph.py |
py | testing | 60 | yes |
tests/test_readme_injector.py |
py | testing | 28 | yes |
-
ensure_readmenator_installed(function,readmenator/_agent_injector.py:120)def ensure_readmenator_installed()- Check if readmenator is installed via pip; install it if missing. -
AgentInjector(class,readmenator/_agent_injector.py:142)class AgentInjector- Injects a link to KNOWLEDGE_BASE.md into AI agent instruction files. -
__init__(method,readmenator/_agent_injector.py:153)def __init__(self, kb_filename, agent_output_dir, agent_files, agent_globs, wiki -
inject(method,readmenator/_agent_injector.py:173)def inject(self, project_root)- Inject KB reference into all discovered agent files. -
remove(method,readmenator/_agent_injector.py:191)def remove(self, project_root)- Remove KB injection from all discovered agent files. -
find_agent_files(method,readmenator/_agent_injector.py:204)def find_agent_files(self, project_root)- Public accessor: return all detected agent files. -
_find_agent_files(method,readmenator/_agent_injector.py:208)def _find_agent_files(self, root) -
_inject_single(method,readmenator/_agent_injector.py:222)def _inject_single(self, path) -
_extract_current_injection(method,readmenator/_agent_injector.py:260)def _extract_current_injection(content) -
_remove_old_injection(method,readmenator/_agent_injector.py:269)def _remove_old_injection(content) -
_remove_single(method,readmenator/_agent_injector.py:279)def _remove_single(self, path) -
_build_injection(method,readmenator/_agent_injector.py:295)def _build_injection(self, fmt) -
_build_mdc_injection(method,readmenator/_agent_injector.py:318)def _build_mdc_injection(self)- Build Cursor .mdc injection body (frontmatter added separately). -
_prepend_mdc_frontmatter(method,readmenator/_agent_injector.py:323)def _prepend_mdc_frontmatter(content, injection)- Prepend Cursor frontmatter so the rule is auto-attached. -
AnalyticsBuilder(class,readmenator/_analytics.py:25)class AnalyticsBuilder- Builds analytics payloads from scanned topology and findings. -
__init__(method,readmenator/_analytics.py:28)def __init__(self, config)- Initialise with application configuration. -
build(method,readmenator/_analytics.py:36)def build(self, nodes, edges, resolved_edges, analysis, findings, layers, v2, ho- Build the full analytics payload. -
_layer_distribution(method,readmenator/_analytics.py:100)def _layer_distribution(self, nodes, layers)- Count files per architectural layer. -
_language_distribution(method,readmenator/_analytics.py:112)def _language_distribution(self, nodes)- Count files per programming language. -
_hotspot_ranking(method,readmenator/_analytics.py:120)def _hotspot_ranking(self, nodes, fan_in, fan_out, hotspots)- Rank files by combined symbol and connectivity weight. -
_rule_yield(method,readmenator/_analytics.py:152)def _rule_yield(self, findings)- Count security findings per rule with severity breakdown. -
_size_bands(method,readmenator/_analytics.py:164)def _size_bands(self, nodes)- Bucket files by symbol-count bands. -
_scatter(method,readmenator/_analytics.py:181)def _scatter(self, nodes, fan_in, fan_out, layers)- Build a file scatter of symbols versus connectivity. -
CodePropertyGraph(class,readmenator/_cpg.py:16)class CodePropertyGraph- Generates a Code Property Graph (CPG) as JSON-LD for AI agent consumption. -
__init__(method,readmenator/_cpg.py:26)def __init__(self, privacy_mode, cpg_context) -
generate(method,readmenator/_cpg.py:30)def generate(self, nodes, edges, resolved_edges, analysis, findings)- Generate the CPG JSON-LD string embeddable in markdown. -
_severity_counts(method,readmenator/_cpg.py:147)def _severity_counts(self, findings) -
_build_symbol_list(method,readmenator/_cpg.py:153)def _build_symbol_list(self, node) -
_compute_node_hash(method,readmenator/_cpg.py:169)def _compute_node_hash(node) -
DocumentationGenerator(class,readmenator/_documentation.py:36)class DocumentationGenerator- Builds the KNOWLEDGE_BASE.md document from scanned nodes and edges.
- Internal resolved imports (EXTRACTED): 29
- Cross-boundary resolved imports (EXTRACTED): 84
- [EXTRACTED] depends_on community 3 <-> 4 (strength 0.9): Extracted import edge crosses communities: readmenator/init.py imports readmenator/_readme_injector.py.
- [EXTRACTED] depends_on community 4 <-> 0 (strength 0.9): Extracted import edge crosses communities: readmenator/_analytics.py imports readmenator/_config.py.
- [EXTRACTED] depends_on community 4 <-> 1 (strength 0.9): Extracted import edge crosses communities: readmenator/_analytics.py imports readmenator/_models.py.
- [EXTRACTED] depends_on community 4 <-> 5 (strength 0.9): Extracted import edge crosses communities: readmenator/_documentation.py imports readmenator/_forcegraph.py.
- [EXTRACTED] depends_on community 4 <-> 6 (strength 0.9): Extracted import edge crosses communities: readmenator/_documentation.py imports readmenator/_flowcharts.py.
- [EXTRACTED] depends_on community 4 <-> 2 (strength 0.9): Extracted import edge crosses communities: readmenator/_pipeline.py imports readmenator/_agent_output.py.
- [taint high]
readmenator/_agent_injector.py->readmenator/_agent_injector.pyviasubprocess(0 hops) - [taint high]
readmenator/_documentation.py->readmenator/_documentation.pyviasubprocess(0 hops) - [taint high]
readmenator/_documentation.py->readmenator/_models.pyviasubprocess(1 hops) - [taint high]
readmenator/_documentation.py->readmenator/_flowcharts.pyviasubprocess(1 hops) - [taint high]
readmenator/_documentation.py->readmenator/_forcegraph.pyviasubprocess(1 hops) - [taint high]
readmenator/_documentation.py->readmenator/_cpg.pyviasubprocess(1 hops) - [taint high]
readmenator/_documentation.py->readmenator/_uml.pyviasubprocess(1 hops) - [taint high]
readmenator/_documentation.py->readmenator/_mermaid.pyviasubprocess(1 hops) - [taint high]
readmenator/_documentation.py->readmenator/_analytics.pyviasubprocess(1 hops) - [taint high]
readmenator/_documentation.py->readmenator/_rank.pyviasubprocess(1 hops) - [taint high]
readmenator/_documentation.py->readmenator/_config.pyviasubprocess(1 hops) - [taint high]
readmenator/_documentation.py->readmenator/_category.pyviasubprocess(2 hops)
- Why do 1 file(s) lack file-level docs (e.g.
tests/test_agent_output.py)? What purpose do they serve? - Is the dangerous import
subprocessinreadmenator/_agent_injector.pystill required, or can it be isolated? - What would break if the most connected file in readmenator: _pipeline changed?
- Should readmenator: _pipeline be split, given cohesion 0.26?
readmenator/_agent_injector.pyreadmenator/_analytics.pyreadmenator/_cpg.pyreadmenator/_documentation.pyreadmenator/_embed.pyreadmenator/_exclusions.pyreadmenator/_explorer.pyreadmenator/_exporter.pyreadmenator/_pipeline.pyreadmenator/_provenance.pyreadmenator/_readme_injector.pyreadmenator/_scantext.pyreadmenator/_uml.pytests/test_agent_injector.pytests/test_agent_output.pytests/test_interactive_graph.pytests/test_readme_injector.py
Generated offline by readmenator from commit 0c608d6d6fa2. Edits here are overwritten by readmenator . --rebuild.
Start
Wiki
- community_0_readmenator_video
- community_1_readmenator_parsers
- community_2_readmenator_agent_output
- community_3_readmenator_graphrag
- community_4_readmenator_pipeline
- community_5_readmenator_diagrams
- community_6_readmenator_flowcharts
- community_7_orphans
- concepts
- queries
- REPORT
Agent Docs
- API
- API_p2
- ARCHITECTURE
- ARCHITECTURE_p2
- CONCEPTS
- GOTCHAS
- INDEX
- KB_misc
- KB_parsers
- KB_readmenator
- KB_readmenator_p2
- KB_readmenator_p3
- KB_readmenator_p4
- KB_readmenator_p5
- KB_root
- KB_tests
- KB_tests_p2
- KB_tests_p3
- KB_tests_p4
- MEMORY
- SECURITY
- SYMBOLS
- SYMBOLS_p2
- SYMBOLS_p3
- SYMBOLS_p4
- SYMBOLS_p5
- SYMBOLS_p6
- SYMBOLS_p7
Recipes