Skip to content

GBOYEE/auto-sme

auto-sme — Deterministic AI Content Pipeline

MIT License Python 3.11+ Docker CI Coverage

AI-assisted content generation that's deterministic, reproducible, and production-ready. auto-sme uses templates, LLMs, and QA validation to generate structured documents (e.g., educational units) end-to-end.

auto-sme pipeline

✨ Features

  • 📝 Template-Driven — Jinja2 templates ensure consistent structure every time
  • 🤖 LLM Integration — Fills content using OpenAI or Ollama
  • 📄 PDF Generation — WeasyPrint produces print-ready, styled PDFs
  • QA Validation — Automated checks for page counts, vocabulary, multiple choice questions
  • 🎨 Asset Generation — SVGs, NGSS alignment, differentiation notes
  • 🐳 Docker Ready — One-command pipeline execution

🚀 Quick Start

git clone https://github.com/GBOYEE/auto-sme.git
cd auto-sme
pip install -e .
auto-sme generate -t templates/earth_science_water_cycle.j2 -o water_cycle.pdf

🏗️ Pipeline Stages

  1. Template Loading — Jinja2 defines document structure
  2. Content Generation — LLM fills placeholders via prompts
  3. Assembly — Insert content into template
  4. PDF Generation — WeasyPrint renders HTML to PDF
  5. QA Validation — Checks page counts, vocab terms, MC counts
  6. Asset Generation — Creates diagrams, alignment notes

See docs/architecture.md for details.

📦 Tech Stack

Component Technology
Templates Jinja2
LLM OpenAI / Ollama
PDF WeasyPrint (CSS-based)
QA Custom validators (coverage, structure)
DevOps Docker, CI

🧪 Testing & CI

pytest tests/ -v --cov=auto_sme

CI runs lint, type-check, tests, and coverage upload on every push.

📚 Documentation

🎯 Roadmap

  • More output formats (EPUB, DOCX)
  • Interactive template builder (web UI)
  • Multi-language support
  • Cloud storage backends (S3, GCS)
  • Collaborative template editing

🤝 Contributing

We need help with:

  • New template examples (different subjects)
  • QA validators for new content types
  • PDF styling improvements
  • Performance optimizations for large documents

See CONTRIBUTING.md.

📄 License

MIT — see LICENSE.


Built by Oyebanji AdegboyegaPortfolio@Gboyee_0

About

No description, website, or topics provided.

Resources

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors