Skip to content

Codeflow Architecture

Internal layout

Source root: src/md_generator/codeflow (139 Python modules detected).

Subpackages and areas: analyzers, api, cli, config, core, detectors, generators, graph, ingestion, mcp, models, parsers, rules, runtime, utils.

Component diagram

flowchart TB
    CLI[CLI_md-codeflow] --> Core[Core_engine]
    API[FastAPI_optional] --> Core
    Core --> Writers[Markdown_writers]
    Core --> Assets[Asset_handlers]
    Core --> Integrations[External_libraries]

Dependency graph (logical)

  • Inputs: Source repositories
  • Outputs: Architecture Markdown, graphs, flow docs, JSON, Mermaid
  • Optional extras: codeflow from pyproject.toml
  • Cross-module: See integration.md for delegated converters and shared job patterns.

Threading and async

  • CLI runs synchronously in the invoking process.
  • FastAPI routes may use background tasks or threads for long jobs.
  • Domain modules (db, graph, log, codeflow) expose SSE/event streams for progress.

Data flow

flowchart LR
    Raw[Raw_input] --> Parse[Parse_or_load]
    Parse --> Model[Internal_representation]
    Model --> Emit[Markdown_emitter]
    Emit --> Out[Files_or_ZIP]