Skip to content

Releases: asadkhalid-softdev/aiagent-storywriter

v1.0.0 - Initial Release

16 Mar 00:32
@asadkhalid-softdev asadkhalid-softdev
v1.0.0
1214d1b
Compare
Choose a tag to compare
v1.0.0 - Initial Release Latest
Latest

v1.0.0 - AI Children's Story Generator

🚀 Overview

The AI-agent-storywriter is a Python-based application that generates children's stories with accompanying illustrations using OpenAI's GPT and DALL-E models. This initial release provides a complete end-to-end solution for creating engaging, age-appropriate stories for children based on simple prompts.

✨ Key Features

  • Interactive Story Generation: Create complete children's stories from simple text prompts
  • Automatic Illustration: Generate matching images for key scenes in each story
  • Child-Appropriate Content: Built-in content filtering ensures all stories are suitable for children
  • Markdown Output: Stories are saved in Markdown format with embedded images
  • Command-Line Interface: Simple CLI with numerous customization options
  • Performance Monitoring: Track and optimize application performance

🔧 Installation

  1. Clone the repository:
git clone https://github.com/asadkhalid-softdev/aiagent-storywriter.git
cd aiagent-storywriter
  1. Run the installation script:
python install.py
  1. Activate the virtual environment:
    • Windows: venv\Scripts\activate
    • macOS/Linux: source venv/bin/activate
  2. Ensure you have set your OpenAI API key in the .env file

📖 Usage

Basic usage:

python main.py

With a specific prompt:

python main.py --prompt "A friendly dragon who teaches children about recycling"

Advanced options:

python main.py --prompt "A space adventure with talking planets" --images 6 --optimize

📋 Requirements

  • Python 3.8 or higher
  • OpenAI API key with access to GPT-4 and DALL-E models
  • Required Python packages (installed automatically via requirements.txt)

🔍 Known Limitations

  • API costs may accumulate with extensive use
  • Image generation can occasionally be slow during peak API usage times
  • Content filtering is robust but not perfect - review stories before sharing with children

📝 Documentation

Comprehensive documentation is available in the docs directory:

  • user_guide.md - Detailed instructions for users
  • developer_guide.md - Information for developers who want to extend the application

🔜 Coming Soon

  • Web interface for easier story creation
  • Batch processing of multiple stories
  • Additional output formats (PDF, EPUB)
  • More customization options for illustrations

🙏 Acknowledgements

Special thanks to OpenAI for providing the API services that power this application.

⁂
Assets 2
Loading