Introduction/Origins

Spout began as my personal workspace for prompt engineering experiments and AutoHotkey automation scripts in 2024. What started as a collection of utilities to streamline my own AI workflows gradually evolved into a comprehensive framework for automation and text management spanning over 10,000 lines of code in multiple languages. After seeing how these tools enhanced my own productivity, I decided to refactor and open-source the project to share these capabilities with the wider online community.

Spout Workspace Anatomy

The order of your folders may differ from the example below depending on the IDE.

spout_workspace/       # Main project parent directory
│
├── spout/             # Main Spout package directory
│   ├── addons/        # Download or create custom extension modules here
│   ├── core/          # Parent Directory for the 12 Core Modules
│   │   ├── converse/  # Module for Multi-turn dialogue and chat systems
│   │   ├── enhance/   # Module for Text refinement and improvement
│   │   ├── evaluate/  # Module for Content scoring and ranking
│   │   ├── expand/    # Module for Text elaboration and detail enhancement
│   │   ├── generate/  # Module for Content creation and batch ideation
│   │   ├── imagine/   # Module for Planning and brainstorming functionalities
│   │   ├── iterate/   # Module for Batch processing and transformation
│   │   ├── mutate/    # Module for Text variation and alternative generation
│   │   ├── parse/     # Module for Text analysis and structure extraction
│   │   ├── reduce/    # Module for Text summarization and content reduction
│   │   ├── search/    # Module for Information retrieval and reference finding
│   │   └── translate/ # Module for Language and format transformation
│   │
│   ├── config/        # Configuration, logging files for the project
│   ├── shared/        # Shared code and resources
│   ├── [consoles]     # Example and custom console AHK files
│   └── [scripts]      # Main program files for Python CLI and AHK scripts
│
├── scripting/         # Home for general purpose automation scripts and tools
├── testing/           # Home for scripts and tools that test modules, spoutlets, and prompts
├── notes/             # Default location for application notes, misc files
│
├── README.md          # Project overview and documentation
├── LICENSE            # Project license
├── CHANGELOG.md       # Project changelog
├── pyproject.toml     # Python package configuration and dependencies
├── quickstart.ahk     # Run this script to start or restart Spout and install new addons
├── spout.egg-info/    # Python package metadata, appears after cli install (ignore this)
└── .gitignore         # Git ignore rules for the project