Skip to main content

An educational content workflow orchestration tool for LLM integration

Project description

Curriculum Curator

An educational content workflow orchestration tool designed to streamline the creation of comprehensive curriculum materials through Large Language Model (LLM) integration.

Core Philosophy

Curriculum Curator is designed around two fundamental principles:

  1. Prompt-centric Content Generation: All content is derived from well-designed prompts managed within the system.
  2. Workflow-driven Process: Content creation follows configurable, automated educational workflows.

Features

  • Prompt Registry: Manage a collection of prompts with metadata using YAML front matter
  • LLM Integration: Support for multiple providers (Anthropic, OpenAI, Ollama, Groq, Gemini) via LiteLLM
  • Content Transformation: Parse and structure raw LLM outputs in various formats
  • Workflow Engine: Orchestrate the sequence of content generation, validation, and remediation steps
  • Interactive Mode: Complete menu-driven interface for all operations
  • Interactive Workflow Builder: Create and edit workflows through a menu-driven interface
  • Interactive Prompt Editor: Create and edit prompts with templates and front matter validation
  • Validation Framework: Ensure content quality and consistency through a suite of validators
  • Multiple Output Formats: Generate HTML, PDF, DOCX, and presentation slide formats
  • Cost Tracking: Monitor token usage and associated costs
  • Session Management: Save, resume, and analyze workflow sessions

Installation

pip install curriculum-curator

Quick Start

# Initialize a new project with example prompts
curator init

# Run the minimal educational module workflow
curator run minimal_educational_module \
  --var course_title="Introduction to Python Programming" \
  --var course_slug="intro-python" \
  --var module_id="module1" \
  --var num_modules=4 \
  --var "learning_objectives=Understand Python basics;Write simple programs"

# Or run the standard course generation workflow
curator run standard_course --var course_title="Introduction to Python Programming"

# List available prompts
curator list-prompts

# List available workflows
curator list-workflows

# Create a new workflow with the interactive builder
curator build-workflow my-workflow.yaml

# Edit prompts interactively with templates
curator edit-prompt

# Launch the fully interactive mode for all operations
curator interactive

# List available validators and remediators
curator list-validators
curator list-remediators

MVP Workflow Ready!

We've completed our first MVP workflow that generates a complete educational module with:

  • Course overview
  • Module outline
  • Lecture content with validation and remediation
  • Worksheet with practice activities
  • Assessment with various question types
  • Instructor guide with teaching suggestions and answer keys

This workflow is fully configuration-driven and validates against a robust schema to catch errors early. See our guides for more details:

Development

Setting up the development environment

# Clone the repository
git clone https://github.com/teaching-repositories/curriculum-curator.git
cd curriculum-curator

# Create and activate a virtual environment
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install development dependencies
pip install -e ".[dev]"

# Install pre-commit hooks
pip install pre-commit
pre-commit install

Running tests

# Run all tests
pytest

# Run tests with coverage report
pytest --cov=curriculum_curator

Documentation

For detailed documentation, visit the Curriculum Curator Docs.

License

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

curriculum_curator-0.2.1.tar.gz (117.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

curriculum_curator-0.2.1-py3-none-any.whl (75.0 kB view details)

Uploaded Python 3

File details

Details for the file curriculum_curator-0.2.1.tar.gz.

File metadata

  • Download URL: curriculum_curator-0.2.1.tar.gz
  • Upload date:
  • Size: 117.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.10.12

File hashes

Hashes for curriculum_curator-0.2.1.tar.gz
Algorithm Hash digest
SHA256 e14acd8ae3a33869c9cbb8f14c782f5e47b5a710eef8a48dafbf9c28b291d89e
MD5 c626aa875551cf2dad76ac9ce8e66682
BLAKE2b-256 2bed0301434d430e77f682ddfd8fec3e9fee7571954b55e72bf8f9e35df001bb

See more details on using hashes here.

File details

Details for the file curriculum_curator-0.2.1-py3-none-any.whl.

File metadata

File hashes

Hashes for curriculum_curator-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 78ec1f57975b6b334da73719a3ca7c08334f2b58743a880beecd3937a3138fcc
MD5 cf3b8e7790243d5726e2c7e063bd5178
BLAKE2b-256 e7e66f5da9dded2c8fcbd94c346309eff2cba6d23affdfae73689b4545dfb6a4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page