kunthawat/ALwrity
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md - Easier to get started with AI agents

Browse Source
This commit is contained in:
ي
2025-01-17 09:34:24 +05:30
committed by GitHub
parent 1d0a3db873
commit a339aa6b29
1 changed files with 54 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files

112
lib/content_planning_calender/README.md
View File

@@ -1,6 +1,7 @@
```markdown
# AI Agents Content Planner # AI Agents Content Planner
This document describes the `ai_agents_planner` module, a sophisticated tool for creating highly detailed and SEO-optimized content calendars. This module leverages AI agents to perform web research, trend analysis, and content planning, ensuring a comprehensive and efficient approach to content strategy. This document describes the `ai_agents_planner` module, a sophisticated tool for creating highly detailed and SEO-optimized content calendars. This module leverages AI agents to perform web research, trend analysis, and content planning.
## Prerequisites ## Prerequisites
@@ -18,45 +19,44 @@ Install the required Python packages using pip:
```bash ```bash
pip install streamlit crewai crewai_tools langchain_google_genai pip install streamlit crewai crewai_tools langchain_google_genai
```
---
## Environment Setup ## Environment Setup
Ensure that you have set up the following environment variables: Ensure that you have set up the following environment variables:
GEMINI_API_KEY: Your Google Gemini API key. - `GEMINI_API_KEY`: Your Google Gemini API key.
SEARCH_SAVE_FILE: Path to the file where search results are saved. - `SEARCH_SAVE_FILE`: Path to the file where search results are saved.
---
## Module Overview ## Module Overview
The ai_agents_planner module consists of several key functions:
create_agents(search_keywords, already_written_on) The `ai_agents_planner` module consists of several key functions:
This function creates the AI agents required for content research and planning. Each agent is assigned a specific role and set of tools to achieve their goals.
content_researcher: Conducts web research to identify content opportunities. - **create_agents(search_keywords, already_written_on)**
content_planner: Develops a content calendar based on the research. - This function creates the AI agents required for content research and planning. Each agent is assigned a specific role and set of tools to achieve their goals.
google_trends_researcher: Analyzes Google Trends data to suggest relevant keywords and titles. - Agents:
content_marketing_manager: Ensures the content calendar is optimized and avoids keyword cannibalization. - **content_researcher**: Conducts web research to identify content opportunities.
create_tasks(agents, search_keywords, already_written_on) - **content_planner**: Develops a content calendar based on the research.
This function creates tasks for each agent. Tasks include web analysis, Google Trends analysis, content calendar development, and final review. - **google_trends_researcher**: Analyzes Google Trends data to suggest relevant keywords and titles.
- **content_marketing_manager**: Ensures the content calendar is optimized and avoids keyword cannibalization.
execute_tasks(agents, tasks) - **create_tasks(agents, search_keywords, already_written_on)**
Executes the tasks assigned to each agent. The results are compiled into a comprehensive content calendar. - This function creates tasks for each agent, including web analysis, Google Trends analysis, content calendar development, and final review.
ai_agents_planner(search_keywords) - **execute_tasks(agents, tasks)**
The main function that orchestrates the creation of agents, assignment of tasks, and execution of the content planning process. It performs Google Trends analysis and generates the final content calendar. - Executes the tasks assigned to each agent. The results are compiled into a comprehensive content calendar.
--- - **ai_agents_planner(search_keywords)**
- The main function that orchestrates the creation of agents, assignment of tasks, and execution of the content planning process. It performs Google Trends analysis and generates the final content calendar.
## Example Usage ## Example Usage
To use the ai_agents_planner module, follow these steps:
Set up the environment variables. To use the `ai_agents_planner` module, follow these steps:
Import the module and call the ai_agents_planner function with your target keywords.
``` 1. Set up the environment variables.
2. Import the module and call the `ai_agents_planner` function with your target keywords.
```python
import os import os
from your_module import ai_agents_planner from your_module import ai_agents_planner
@@ -66,54 +66,50 @@ os.environ['SEARCH_SAVE_FILE'] = '/path/to/search_save_file.txt'
# Run the planner # Run the planner
ai_agents_planner('your_target_keywords') ai_agents_planner('your_target_keywords')
``` ```
---
## Detailed Agent Roles and Responsibilities ## Detailed Agent Roles and Responsibilities
### Content Researcher: Aisha Sharma ### Content Researcher: Aisha Sharma
Role: Senior Web Research Analyst (Content Strategy) **Role**: Senior Web Research Analyst (Content Strategy)
Goal: Create a detailed content calendar focused on specific keywords. **Goal**: Create a detailed content calendar focused on specific keywords.
Responsibilities: **Responsibilities**:
- Conduct web research and competitor analysis.
Conduct web research and competitor analysis. - Identify high-value content opportunities.
Identify high-value content opportunities.
Content Planner: Ted XingPi
Role: Senior Content Strategist & Planner
Goal: Craft a series of content titles for a 2-month-long series.
Responsibilities:Develop a content calendar with unique and non-repetitive titles.
Ensure alignment with SEO best practices.
### Content Planner: Ted XingPi
**Role**: Senior Content Strategist & Planner
**Goal**: Craft a series of content titles for a 2-month-long series.
**Responsibilities**:
- Develop a content calendar with unique and non-repetitive titles.
- Ensure alignment with SEO best practices.
### Google Trends Researcher: Sarah Qureshi ### Google Trends Researcher: Sarah Qureshi
Role: Content Marketing & Google Trends Specialist **Role**: Content Marketing & Google Trends Specialist
Goal: Analyze Google Trends data and provide keyword recommendations. **Goal**: Analyze Google Trends data and provide keyword recommendations.
Responsibilities: **Responsibilities**:
- Identify high-volume, low-competition keywords.
Identify high-volume, low-competition keywords. - Collaborate on content strategy and planning.
Collaborate on content strategy and planning.
### Content Marketing Manager: Diksha Yuj ### Content Marketing Manager: Diksha Yuj
Role: Content Marketing Manager **Role**: Content Marketing Manager
Goal: Optimize the content calendar and ensure no keyword cannibalization. **Goal**: Optimize the content calendar and ensure no keyword cannibalization.
Responsibilities: **Responsibilities**:
- Review and finalize the content calendar.
- Ensure all content is unique and SEO-optimized.
Review and finalize the content calendar. ## Final Content Calendar
Ensure all content is unique and SEO-optimized.
The result of the `ai_agents_planner` module is a highly detailed content calendar that positions your target keywords effectively. The content calendar includes:
- Head Term Keyword
- Long-Tail Keyword
- Blog Post Title
### Final Content Calendar
The result of the ai_agents_planner module is a highly detailed content calendar that positions your target keywords effectively. The content calendar includes:
Head Term Keyword
Long-Tail Keyword
Blog Post Title
This structured approach ensures a comprehensive content strategy, optimized for search engines and tailored to your audience. This structured approach ensures a comprehensive content strategy, optimized for search engines and tailored to your audience.
## Conclusion
### Conclusion The `ai_agents_planner` module provides a robust framework for content planning and strategy. By leveraging AI agents and integrating web research, trend analysis, and content planning, it delivers a detailed content calendar tailored to your audience and optimized for search engines.
The ai_agents_planner module provides a robust framework for content planning and strategy. By leveraging AI agents and integrating web research, trend analysis, and content planning, it delivers a detailed and SEO-optimized content calendar that drives organic growth.
For further information and detailed documentation, refer to the module's code and comments. For further information and detailed documentation, refer to the module's code and comments.
```