add streamlit app

.gitignore

@@ -0,0 +1,3 @@
+.env
+__pycache__/
+lib/

README.md

@@ -10,3 +10,60 @@ pinned: false
 ---
 
 Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+
+# Education Book Generator Crew
+
+Welcome to the Education Book Generator Crew project, powered by [crewAI](https://crewai.com). This template is designed to help you set up a multi-agent AI system with ease, leveraging the powerful and flexible framework provided by crewAI. Our goal is to enable your agents to collaborate effectively on complex tasks, maximizing their collective intelligence and capabilities.
+
+## Installation
+
+Ensure you have Python >=3.10 <3.13 installed on your system. This project uses [UV](https://docs.astral.sh/uv/) for dependency management and package handling, offering a seamless setup and execution experience.
+
+First, if you haven't already, install uv:
+
+```bash
+pip install uv
+```
+
+Next, navigate to your project directory and install the dependencies:
+
+(Optional) Lock the dependencies and install them by using the CLI command:
+```bash
+crewai install
+```
+
+### Customizing
+
+**Add your `OPENAI_API_KEY` into the `.env` file**
+
+- Modify `src/educational_books/config/agents.yaml` to define your agents
+- Modify `src/educational_books/config/tasks.yaml` to define your tasks
+- Modify `src/educational_books/crew.py` to add your own logic, tools and specific args
+- Modify `src/educational_books/main.py` to add custom inputs for your agents and tasks
+
+## Running the Project
+
+To kickstart your crew of AI agents and begin task execution, run this from the root folder of your project:
+
+```bash
+crewai run
+```
+
+This command initializes the educational_books Crew, assembling the agents and assigning them tasks as defined in your configuration.
+
+This example, unmodified, will run the create a `report.md` file with the output of a research on LLMs in the root folder.
+
+## Understanding Your Crew
+
+The educational_books Crew is composed of multiple AI agents, each with unique roles, goals, and tools. These agents collaborate on a series of tasks, defined in `config/tasks.yaml`, leveraging their collective skills to achieve complex objectives. The `config/agents.yaml` file outlines the capabilities and configurations of each agent in your crew.
+
+## Support
+
+For support, questions, or feedback regarding the {{crew_name}} Crew or crewAI.
+
+- Visit our [documentation](https://docs.crewai.com)
+- Reach out to us through our [GitHub repository](https://github.com/joaomdmoura/crewai)
+- [Join our Discord](https://discord.com/invite/X4JWnZnxPb)
+- [Chat with our docs](https://chatg.pt/DWjSBZn)
+
+Let's create wonders together with the power and simplicity of crewAI.

app.py

@@ -0,0 +1,91 @@
+import streamlit as st
+from src.educational_books.main import BookFlow
+import threading
+import time
+
+def reset_state():
+  st.session_state.book_outline = None
+  st.session_state.book = None
+  st.session_state.title = None
+  st.session_state.book_flow = None
+  st.session_state.section_finished = 0
+  st.session_state.total_sections = 0
+
+def start_generation(topic):
+  book_flow = BookFlow()
+  st.session_state.book_flow = book_flow
+  def run_kickoff():
+    book_flow.kickoff(inputs={"topic": topic})
+  kickoff_thread = threading.Thread(target=run_kickoff)
+  kickoff_thread.start()
+
+def update_state():
+  book_flow = st.session_state.get("book_flow", None)
+  if book_flow is not None:
+    if hasattr(book_flow.state, "book_outline") and book_flow.state.book_outline and st.session_state.book_outline is None:
+      st.session_state.book_outline = book_flow.state.book_outline_md
+      st.session_state.title = book_flow.state.title
+      st.session_state.total_sections = len(book_flow.state.book_outline)
+    if hasattr(book_flow.state, "section_finished") and book_flow.state.section_finished != st.session_state.section_finished:
+      st.session_state.section_finished = book_flow.state.section_finished
+    if hasattr(book_flow.state, "book") and book_flow.state.book and st.session_state.book is None:
+      st.session_state.book = book_flow.state.book_md
+      st.session_state.generation_started = False
+
+st.title("Educational Book Generator")
+topic = st.text_input("Enter the topic for the book:", "Bubble Sort")
+
+if "generation_started" not in st.session_state:
+  st.session_state.generation_started = False
+if "book_outline" not in st.session_state:
+  st.session_state.book_outline = None
+if "book" not in st.session_state:
+  st.session_state.book = None
+if "title" not in st.session_state:
+  st.session_state.title = None
+if "book_flow" not in st.session_state:
+  st.session_state.book_flow = None
+if "section_finished" not in st.session_state:
+  st.session_state.section_finished = 0
+
+# Button to start generation
+if st.button("Generate Book"):
+  st.session_state.generation_started = True
+  reset_state()
+  start_generation(topic)
+
+# Show "Generating book..." message if the process has started
+if st.session_state.generation_started:
+  if st.session_state.book_outline is None:
+    st.write("Generating book outline... Please wait.")
+  elif st.session_state.book is None:
+    st.write("Book Outline is ready")
+    outline_filename = f"{st.session_state.title.replace(' ', '_')}_outline.md"
+    st.download_button(
+      label="Download Book Outline",
+      data=st.session_state.book_outline,
+      file_name=outline_filename,
+      mime="text/markdown"
+    )
+    st.progress(st.session_state.section_finished / st.session_state.total_sections, text=f"Generating book content... {st.session_state.section_finished}/{st.session_state.total_sections}")
+elif st.session_state.book_outline is not None and st.session_state.book is not None:
+  st.write("Book Outline is ready")
+  outline_filename = f"{st.session_state.title.replace(' ', '_')}_outline.md"
+  st.download_button(
+    label="Download Book Outline",
+    data=st.session_state.book_outline,
+    file_name=outline_filename,
+    mime="text/markdown"
+  )
+  st.write("Book content is ready")
+  content_filename = f"{st.session_state.title.replace(' ', '_')}.md"
+  st.download_button(
+    label="Download Generated Book",
+    data=st.session_state.book,
+    file_name=content_filename,
+    mime="text/markdown"
+  )
+if st.session_state.generation_started:
+  time.sleep(5)
+  update_state()
+  st.rerun()

pyproject.toml

@@ -0,0 +1,20 @@
+[project]
+name = "educational_books"
+version = "0.1.0"
+description = "educational_books using crewAI"
+authors = [{ name = "Your Name", email = "you@example.com" }]
+requires-python = ">=3.10,<3.13"
+dependencies = [
+    "crewai[tools]>=0.95.0,<1.0.0"
+]
+
+[project.scripts]
+kickoff = "educational_books.main:kickoff"
+plot = "educational_books.main:plot"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.crewai]
+type = "flow"

requirements.txt

@@ -0,0 +1,6 @@
+crewai
+crewai-tools
+pydantic
+langchain-groq
+langchain-community
+streamlit

src/educational_books/crews/book_content/book_content.py

@@ -0,0 +1,48 @@
+from crewai import Agent, Crew, Process, Task, LLM
+from crewai.project import CrewBase, agent, crew, task
+from crewai_tools import SerperDevTool
+from dotenv import load_dotenv
+import streamlit as st
+import os
+
+from educational_books.types import Section
+
+load_dotenv()
+if not os.getenv("GEMINI_API_KEY"):
+  os.environ["GEMINI_API_KEY"] = st.secrets["google_api_key"]
+
+if not os.getenv("SERPER_API_KEY"):
+  os.environ["SERPER_API_KEY"] = st.secrets["serper_api_key"]
+
+@CrewBase
+class BookContentCrew():
+  """BookContent crew"""
+  agents_config = 'config/agents.yaml'
+  tasks_config = 'config/tasks.yaml'
+  llm = LLM(model="gemini/gemini-2.0-flash-exp")
+
+  @agent
+  def researcher(self) -> Agent:
+    return Agent(config=self.agents_config['researcher'], llm=self.llm, tools=[SerperDevTool()])
+  
+  @agent
+  def writer(self) -> Agent:
+    return Agent(config=self.agents_config['writer'], llm=self.llm, verbose=True)
+
+  @task
+  def research_section(self) -> Task:
+    return Task(config=self.tasks_config['research_section'], agent=self.researcher())
+  
+  @task
+  def write_section(self) -> Task:
+    return Task(config=self.tasks_config['write_section'], agent=self.writer(), output_pydantic=Section)
+
+  @crew
+  def crew(self) -> Crew:
+    """Creates the Bookoutline crew"""
+    return Crew(
+      agents=self.agents,
+      tasks=self.tasks,
+      process=Process.sequential,
+      max_rpm=10,
+    )

src/educational_books/crews/book_content/config/agents.yaml

@@ -0,0 +1,21 @@
+researcher:
+  role: >
+    Research Agent
+  goal: >
+    Gather comprehensive information about {topic} and {section_title} that will be used to create a well-informed and engaging section for the book.
+    Here is the outline description for the section:\n\n {section_description}
+    Here is the skill or key points that will be covered in this section:\n\n {covered_skills}
+  backstory: >
+    You are an experienced researcher skilled in finding the most relevant and up-to-date information on any given topic. 
+    Your job is to provide educational content that is backed by solid research and reliable sources.
+
+writer:
+  role: >
+    Section Writer
+  goal: >
+    Write a well-structured section for the book based on the provided section title and outline.
+    The section should be written in markdown format and contain around 2,000 words.
+    If there are code snippets or examples, they need to be included in the section
+  backstory: >
+    You are an exceptional writer, known for producing engaging, well-researched, and informative content. 
+    You excel at transforming complex ideas into readable and well-organized sections.

src/educational_books/crews/book_content/config/tasks.yaml

@@ -0,0 +1,34 @@
+research_section:
+  description: >
+    Research the provided section topic, title, and outline to gather additional content that will be helpful in writing the section.
+    Ensure you focus on reliable, high-quality sources of information.
+
+    Here is the outline description for the section:\n\n {section_description}
+    Here is the skill or key points that will be covered in this section:\n\n {covered_skills}
+
+    When researching, consider the following key points:
+    - you need to gather enough information to write a 2,000-word section
+    - The section you are researching needs to fit in well with the rest of the sections in the book.
+
+    Here is the outline of the entire book:\n\n
+    {book_outline}
+  expected_output: >
+    A set of reliable and high-quality content that will be used to write the section. This content should be well-organized and relevant to the section topic.
+
+write_section:
+  description: >
+    Write a well-structured section based on the section title, goal, and outline description. 
+    Each section should be written in markdown and should contain around 2,000 words.
+
+    Here is the topic for the book: {topic}
+    Here is the title of the section: {section_title}
+    Here is the outline description for the section:\n\n {section_description}
+    Here is the skill or key points that will be covered in this section:\n\n {covered_skills}
+
+    Important notes:
+    - The section you are writing needs to fit in well with the rest of the sections in the book.
+
+    Here is the outline of the entire book:\n\n
+    {book_outline}
+  expected_output: >
+    A markdown-formatted section of around 2,000 words that covers the provided section title and outline description.

src/educational_books/crews/book_outline/book_outline.py

@@ -0,0 +1,48 @@
+from crewai import Agent, Crew, Process, Task, LLM
+from crewai.project import CrewBase, agent, crew, task
+from crewai_tools import SerperDevTool
+from dotenv import load_dotenv
+import streamlit as st
+import os
+
+from educational_books.types import BookOutline
+
+load_dotenv()
+if not os.getenv("GEMINI_API_KEY"):
+  os.environ["GEMINI_API_KEY"] = st.secrets["google_api_key"]
+
+if not os.getenv("SERPER_API_KEY"):
+  os.environ["SERPER_API_KEY"] = st.secrets["serper_api_key"]
+
+@CrewBase
+class BookOutlineCrew():
+  """Bookoutline crew"""
+  agents_config = 'config/agents.yaml'
+  tasks_config = 'config/tasks.yaml'
+  llm = LLM(model="gemini/gemini-2.0-flash-exp")
+
+  @agent
+  def researcher(self) -> Agent:
+    return Agent(config=self.agents_config['researcher'], llm=self.llm, tools=[SerperDevTool()])
+
+  @agent
+  def planner(self) -> Agent:
+    return Agent(config=self.agents_config['planner'], llm=self.llm, verbose=True)
+
+  @task
+  def research_topic(self) -> Task:
+    return Task(config=self.tasks_config['research_topic'], agent=self.researcher())
+
+  @task
+  def generate_outline(self) -> Task:
+    return Task(config=self.tasks_config['generate_outline'], agent=self.planner(), output_pydantic=BookOutline)
+
+  @crew
+  def crew(self) -> Crew:
+    """Creates the Bookoutline crew"""
+    return Crew(
+      agents=self.agents,
+      tasks=self.tasks,
+      process=Process.sequential,
+      max_rpm=10,
+    )

src/educational_books/crews/book_outline/config/agents.yaml

@@ -0,0 +1,21 @@
+researcher:
+  role: >
+    Research Agent
+  goal: >
+    Gather comprehensive information about {topic} that will be used to create an organized and well-structured educational book outline.
+    that can be easily understood by university students.
+  backstory: >
+    You're a seasoned researcher, known for gathering the best sources and understanding the key elements of any topic. 
+    You aim to collect all relevant information so the book outline can be developed with the most accurate and up-to-date content.
+
+planner:
+  role: >
+    Outlining Planner
+  goal: >
+    Develop engaging and effective outline based on {topic}. This includes breaking down {topic} into smaller, 
+    more manageable sections that are easy for students to follow and understand. The outline should be structured
+    in a way that allows students to progress through the book with ease from beginner to advanced levels.
+  backstory: >
+    You're a creative and detail-oriented planner with a passion for designing engaging and effective educational book outlines.
+    You have a deep understanding of the key concepts and skills related to {topic}, and you're able to break down 
+    complex topics into smaller, more manageable sections that are easy for students to follow and understand

src/educational_books/crews/book_outline/config/tasks.yaml

@@ -0,0 +1,29 @@
+research_topic:
+  description: >
+    Research the provided topic of {topic} to gather the most important information that will 
+    be useful in creating a educational book outline. Ensure you focus on high-quality, reliable sources.
+    The information should focus on educational content that is relevant.
+  expected_output: >
+    A set of key points and important information about {topic} that will be used to create the outline.
+
+generate_outline:
+  description: >
+    Create an educational book outline with sections in sequential order so that students can easily follow and understand the content in order.
+    Ensure that each sections has a title and a brief description that highlights what will be covered in that section.
+    Each sections also contain a list of skills or key concepts that will be covered.
+    It's important to note that the order of the sections should make sense and flow logically for students to learn effectively.
+    Also, make sure that you do not duplicate any sections or topics in the outline.
+  expected_output: >
+    A book title, list of outline sections with a title, brief description,  list of skills or key concepts, and list of objectives that will be covered in that section.
+    Example:
+    Book Title: ...
+    Sections: [
+      {
+        title: ...,
+        description: ...,
+        covered_skills: [...],
+        objectives: [...]
+      },
+      ...
+    ]
+    Minimum of sections should be 3 and maximum should be 15.

src/educational_books/main.py

@@ -0,0 +1,92 @@
+#!/usr/bin/env python
+from pydantic import BaseModel
+from typing import List
+from crewai.flow.flow import Flow, listen, start
+from educational_books.crews.book_outline.book_outline import BookOutlineCrew
+from educational_books.crews.book_content.book_content import BookContentCrew
+from educational_books.types import Section, SectionOutline
+import asyncio
+
+class BookState(BaseModel):
+  title: str = "Mastering Data Structures and Algorithms"
+  book: List[Section] = []
+  book_outline: List[SectionOutline] = []
+  topic: str = "Sorting Algorithms"
+  book_outline_md: str = ""
+  book_md: str = ""
+  section_finished: int = 0
+
+class BookFlow(Flow[BookState]):
+  initial_state = BookState
+
+  def write_to_file(self, filename: str, content: str, mode: str = "a"):
+    """Helper method to write content to the file"""
+    with open(filename, mode) as f:
+      f.write(content)
+
+  @start()
+  def initialize(self, topic: str = None):
+    if topic:
+      self.state.topic = topic
+
+  @listen(initialize)
+  def generate_book_outline(self):
+    print("Generating book outline")
+    crew = BookOutlineCrew()
+    outline = crew.crew().kickoff(inputs={"topic": self.state.topic})
+    self.state.title = outline["title"]
+    for section in outline["sections"]:
+      self.state.book_outline_md += f"# {section.title}\n"
+      self.state.book_outline_md += f"{section.description}\n\n"
+      self.state.book_outline_md += f"## Covered Skills\n"
+      for skill in section.covered_skills:
+        self.state.book_outline_md += f"- {skill}\n"
+      self.state.book_outline_md += "\n"
+      self.state.book_outline_md += f"## Learning Objectives\n"
+      for objective in section.objectives:
+        self.state.book_outline_md += f"- {objective}\n"
+      self.state.book_outline_md += "\n"
+    self.state.book_outline = outline["sections"]
+
+  @listen(generate_book_outline)
+  async def generate_book(self):
+    print("Generating book")
+    crew = BookContentCrew()
+    tasks = []
+    book_outline = [(i, section.title, section.description, section.covered_skills) for i, section in enumerate(self.state.book_outline)]
+
+    async def generate_section(section):
+      content = crew.crew().kickoff(inputs={
+        "topic": self.state.topic,
+        "section_title": section.title,
+        "section_description": section.description,
+        "covered_skills": section.covered_skills,
+        "book_outline": book_outline
+      })
+      title = content["title"]
+      content = content["content"]
+      section = Section(title=title, content=content)
+      section_content = f"# {title}\n\n{content}\n\n"
+      self.state.book_md += section_content
+      self.state.section_finished += 1
+      return section
+    for section in self.state.book_outline:
+      print(f"Generating content for {section.title}")
+      task = asyncio.create_task(generate_section(section))
+      tasks.append(task)
+
+    sections = await asyncio.gather(*tasks)
+    self.state.book = sections
+    print(f"Book generated with {len(self.state.book)} sections")
+
+def kickoff():
+  book_name = BookFlow()
+  book_name.kickoff()
+
+def plot():
+  book_name = BookFlow()
+  book_name.plot()
+
+
+if __name__ == "__main__":
+  kickoff()

src/educational_books/tools/custom_tool.py

@@ -0,0 +1,22 @@
+from typing import Type
+
+from crewai.tools import BaseTool
+from pydantic import BaseModel, Field
+
+
+class MyCustomToolInput(BaseModel):
+    """Input schema for MyCustomTool."""
+
+    argument: str = Field(..., description="Description of the argument.")
+
+
+class MyCustomTool(BaseTool):
+    name: str = "Name of my tool"
+    description: str = (
+        "Clear description for what this tool is useful for, your agent will need this information to use it."
+    )
+    args_schema: Type[BaseModel] = MyCustomToolInput
+
+    def _run(self, argument: str) -> str:
+        # Implementation goes here
+        return "this is an example of a tool output, ignore it and move along."

src/educational_books/types.py

@@ -0,0 +1,15 @@
+from typing import List
+from pydantic import BaseModel
+class SectionOutline(BaseModel):
+  title: str
+  description: str
+  covered_skills: List[str]
+  objectives: List[str]
+
+class BookOutline(BaseModel):
+  title: str
+  sections: List[SectionOutline]
+
+class Section(BaseModel):
+  title: str
+  content: str