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

Readme files for library modules

Browse Source
This commit is contained in:
ajaysi
2024-07-01 12:31:24 +05:30
parent 60f0bbaa07
commit 97ece766c9
3 changed files with 245 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
lib/blog_metadata/README.md Normal file
View File

@@ -0,0 +1,34 @@
#AI Blog Metadata Generator
This document outlines the AI Blog Metadata Generator module, designed to assist in creating SEO-optimized metadata for blog articles. This module utilizes artificial intelligence to generate high-quality, engaging, and SEO-friendly content. Below, you will find the details of the module's functionalities, prerequisites, installation process, and usage instructions.
## Prerequisites
To use this module, ensure that the following prerequisites are met:
Python 3.6 or higher
Streamlit
Loguru
Asyncio
A GPT provider (e.g., OpenAI, Gemini)
Installation
Install the required packages using the Python package installer, pip.
## Usage
To utilize the AI Blog Metadata Generator module, follow these steps:
## Generate Blog Title
The module provides a function to create a blog title that is both SEO-optimized and engaging. This function ensures the title adheres to SEO best practices and avoids negative keywords.
## Generate Meta Description
This functionality creates a compelling meta description for the blog content. The description is kept between 150-160 characters to ensure it meets SEO standards.
## Generate Blog Tags
The module suggests relevant and specific tags for the blog content. This helps in categorizing and improving the discoverability of the blog post.
## Generate Blog Categories
The module identifies the main topics and suggests the most relevant categories for the blog content. This function ensures that the blog is categorized appropriately for the target audience and taxonomy.
## Helper Functions
The module includes helper functions to run the asyncio event loop within Streamlit. This ensures smooth and efficient operation of asynchronous tasks such as generating metadata.
By leveraging this module, users can enhance their blog posts with well-crafted metadata, improving their visibility and engagement in search engines.

92
lib/blog_postprocessing/README.md Normal file
View File

@@ -0,0 +1,92 @@
Overview
The AI Writer Blog Post-Processing module provides various utilities for enhancing, formatting, and managing blog content. The tools available in this module help automate tasks such as proof-reading, converting content to Markdown, converting Markdown to HTML, humanizing blog content, and saving processed blog content to a file.
Modules
1. blog_proof_reader.py
Description:
This module provides functionality for proofreading blog content. It corrects grammar, enhances vocabulary, improves sentence structure, aligns tone and brand voice, optimizes content structure, and simplifies concepts.
Usage:
```
from blog_proof_reader import blog_proof_editor
# Example usage
blog_content = "Your raw blog content here"
edited_content = blog_proof_editor(blog_content)
print(edited_content)
```
2. convert_content_to_markdown.py
Description:
This module converts blog content to Markdown format to enhance readability and visual appeal. It follows best practices for structuring content using Markdown.
Usage:
```
from convert_content_to_markdown import convert_tomarkdown_format
# Example usage
blog_content = "Your raw blog content here"
markdown_content = convert_tomarkdown_format(blog_content, gpt_provider="openai")
print(markdown_content)
```
3. convert_markdown_to_html.py
Description:
This module converts Markdown content to HTML. (Implementation details are required to provide a specific example).
Usage:
```
from convert_markdown_to_html import convert_to_html
# Example usage
markdown_content = "Your Markdown content here"
html_content = convert_to_html(markdown_content)
print(html_content)
```
4. humanize_blog.py
Description:
This module "humanizes" blog content by avoiding overused and robotic phrases, replacing them with more natural language to improve readability and engagement.
Usage:
```
from humanize_blog import blog_humanize
# Example usage
blog_content = "Your raw blog content here"
humanized_content = blog_humanize(blog_content)
print(humanized_content)
```
5. save_blog_to_file.py
Description:
This module saves processed blog content to a file. (Implementation details are required to provide a specific example).
Usage:
```
from save_blog_to_file import save_to_file
# Example usage
blog_content = "Your processed blog content here"
file_path = "path/to/save/blog.txt"
save_to_file(blog_content, file_path)
```
~/AI-Writer/lib/blog_postprocessing
├── blog_proof_reader.py
├── convert_content_to_markdown.py
├── convert_markdown_to_html.py
├── humanize_blog.py
└── save_blog_to_file.py
This README file should help you understand the purpose and functionality of each module within the AI Writer Blog Post-Processing directory. Adjust the usage examples and descriptions as per the actual implementations and additional details of your modules.

119
lib/content_planning_calender/README.md Normal file
View File

@@ -0,0 +1,119 @@
# 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.
## Prerequisites
To use this module, ensure the following are installed:
- Python 3.6 or higher
- Streamlit
- Crewai
- Crewai Tools
- Langchain Google GenAI
- Google Gemini API key
## Installation
Install the required Python packages using pip:
```bash
pip install streamlit crewai crewai_tools langchain_google_genai
---
## Environment Setup
Ensure that you have set up the following environment variables:
GEMINI_API_KEY: Your Google Gemini API key.
SEARCH_SAVE_FILE: Path to the file where search results are saved.
---
## Module Overview
The ai_agents_planner module consists of several key functions:
create_agents(search_keywords, already_written_on)
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.
content_planner: Develops a content calendar based on the research.
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.
create_tasks(agents, search_keywords, already_written_on)
This function creates tasks for each agent. Tasks include web analysis, Google Trends analysis, content calendar development, and final review.
execute_tasks(agents, tasks)
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
To use the ai_agents_planner module, follow these steps:
Set up the environment variables.
Import the module and call the ai_agents_planner function with your target keywords.
```
import os
from your_module import ai_agents_planner
# Set up environment variables
os.environ['GEMINI_API_KEY'] = 'your_google_gemini_api_key'
os.environ['SEARCH_SAVE_FILE'] = '/path/to/search_save_file.txt'
# Run the planner
ai_agents_planner('your_target_keywords')
```
---
## Detailed Agent Roles and Responsibilities
### Content Researcher: Aisha Sharma
Role: Senior Web Research Analyst (Content Strategy)
Goal: Create a detailed content calendar focused on specific keywords.
Responsibilities:
Conduct web research and competitor analysis.
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.
### Google Trends Researcher: Sarah Qureshi
Role: Content Marketing & Google Trends Specialist
Goal: Analyze Google Trends data and provide keyword recommendations.
Responsibilities:
Identify high-volume, low-competition keywords.
Collaborate on content strategy and planning.
### Content Marketing Manager: Diksha Yuj
Role: Content Marketing Manager
Goal: Optimize the content calendar and ensure no keyword cannibalization.
Responsibilities:
Review and finalize the content calendar.
Ensure all content is unique and SEO-optimized.
### 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.
### 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 and SEO-optimized content calendar that drives organic growth.
For further information and detailed documentation, refer to the module's code and comments.