ModuFlow

Contents:

  • Overview
    • The Problem ModuFlow Solves
    • Design-First Approach
      • Sequence Diagrams
      • Class Diagrams
    • AI-Driven Module Definition
    • Development Workflow
    • Module-Focused AI Development
    • Module Independence and Integration
  • Installation
    • Development Installation
    • Requirements
  • ModuFlow Usage Guide
    • Installation
    • Getting Started
      • Initializing a Project
      • Creating Modules
      • Adding Files to Modules
      • Adding a File to Multiple Modules
    • Working with Modules
      • Listing Modules
      • Analyzing the Project Structure
    • Compilation
      • Compiling a Module
      • Compiling All Modules
      • Compiling the Entire Project
    • Configuration Management
      • Compiling Configuration Files
    • Working with AI Development
      • Getting the Development Prompt
    • Examples
      • Creating a Web Application with Modules
    • Advanced Usage
      • Using Environment Variables
      • Custom YAML Structure
    • Troubleshooting
      • Common Issues
      • Getting Help
  • API Reference
    • CLI Module
      • Commands
      • Main
    • Core Module
      • Config
        • ConfigManager
      • Exceptions
        • CompilationError
        • ConfigError
        • FileError
        • ModuFlowError
        • SectionError
        • SectionNotFoundError
      • Paths
        • PathManager
    • Compilers Module
      • Project Compiler
        • ProjectCompiler
      • Section Compiler
        • SectionCompiler
    • Handlers Module
      • File Handler
        • FileHandler
      • Section Handler
        • SectionHandler
      • YAML Handler
        • YamlHandler
    • Prompts Module
      • Templates
        • PromptGenerator
    • Utils Module
      • Helpers
        • camel_to_snake()
        • find_project_root()
        • get_terminal_width()
        • is_path_within()
        • list_python_modules()
        • normalize_path()
        • run_command()
        • snake_to_camel()
  • ModuFlow Development Guide
    • Project Structure
    • Development Setup
    • Branch Strategy
    • Testing
    • Code Style
    • Documentation
    • Release Process
    • Adding New Commands
    • Working with Sections
    • Contributing
  • Testing ModuFlow
    • Running Tests
    • Test Structure
    • Writing Tests
      • Example Test Structure
    • Integration with CI/CD
    • Adding More Tests
    • Test Coverage
ModuFlow
  • Search

© Copyright 2025, Brian Onang'o.

Built with Sphinx using a theme provided by Read the Docs.