Codeflow Module Overview¶
Purpose¶
The Codeflow module (md_generator.codeflow) converts Source repositories into Architecture Markdown, graphs, flow docs, JSON, Mermaid. It exists so teams can publish searchable, diff-friendly Markdown from operational inputs without maintaining separate documentation pipelines per format.
Problem solved¶
- Manual copy/paste from Source repositories into wikis does not scale.
- Downstream AI/RAG workflows need stable text and asset bundles.
- CI and gateways need a consistent CLI/API surface across
mdenginemodules.
When to use¶
- You need repeatable Markdown export from Source repositories.
- You want CLI automation, HTTP conversion, or MCP tool integration (where implemented).
- You can install the
codeflowoptional extra (andapifor HTTP services).
When not to use¶
- Inputs fall outside supported formats or size limits enforced by the module.
- You require authenticated multi-tenant SaaS features (not provided by this module; use gateway auth).
- You need transactional writes into application databases (this module documents or transforms; it does not own app schemas except metadata export modules).
Package facts¶
| Item | Value |
|---|---|
| Import path | md_generator.codeflow |
| Source tree | src/md_generator/codeflow |
| CLI | md-codeflow |
| Alternate CLI | codeflow / mdengine codeflow-to-md scan |
| PyPI extra | codeflow |
| Complexity tier | complex |
| API service name | codeflow-to-md |
Primary entry points¶
run_scanScanConfigbuild_output_zipbuild_graph
flowchart LR
Input[Input] --> Validate[Validate]
Validate --> Core[codeflow_core]
Core --> Markdown[Markdown_output]
Core --> Assets[Optional_assets]