Skip to content

Agent API_p2

Jump to bottom
grisun0 edited this page Oct 8, 2026 · 29 revisions

API (page 2 of 2)

Previous: API.md

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

readmenator/_vendor/force-graph.min.js

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

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

Imported by: readmenator/_app.py, tests/test_interactive_graph.py

  • YaraLiteRule.tier (method) readmenator/_yaralite.py:42 def tier(self) -- Return the rule tier from meta or name prefix.
  • YaraLiteMatch.parse_yaralite_rules (method) readmenator/_yaralite.py:76 def parse_yaralite_rules(rules_text) -- Parse YARA-lite rules text into rules and error messages.
  • YaraLiteMatch.run_yaralite_rules (method) readmenator/_yaralite.py:112 def run_yaralite_rules(text, rules) -- Run parsed rules against a scan-text blob.
  • YaraLiteMatch.validate_yaralite_rules (method) readmenator/_yaralite.py:139 def validate_yaralite_rules(rules_text) -- Validate rules text and summarize tier counts.
  • YaraLiteMatch.replace_group (method) readmenator/_yaralite.py:270 def replace_group(match) -- Replace an N-of group with its boolean outcome.
  • YaraLiteMatch.replace_identifier (method) readmenator/_yaralite.py:292 def replace_identifier(match) -- Replace a string identifier with its hit boolean.

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

readmenator_orchestrator.py

Generated offline by readmenator from commit 3ee91a383bd9. Edits here are overwritten by readmenator . --rebuild.

Start

Wiki

Agent Docs

Recipes

Clone this wiki locally