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

Update README.md

Browse Source
This commit is contained in:
ي
2025-01-17 09:56:26 +05:30
committed by GitHub
parent 6580653d80
commit 99f1d15921
2 changed files with 117 additions and 116 deletions
Download Patch File Download Diff File Expand all files Collapse all files

116
lib/ai_marketing_tools/README
View File

@@ -1,116 +0,0 @@
```markdown
# AI Backlinking Tool
## Overview
The `ai_backlinking.py` module, part of the [AI-Writer](https://github.com/AJaySi/AI-Writer) project, automates the process of finding and securing backlink opportunities. This AI-powered tool performs web research, scrapes websites, extracts contact information, and sends personalized outreach emails to webmasters for guest posting opportunities.
## Key Features
- **Automated Web Scraping**: Scrape websites for guest post opportunities using predefined search queries based on user input. Extract key information like email addresses, names, and submission guidelines.
- **Personalized Email Writing**: Leverage AI to create personalized emails using the scraped website information, tailored to the tone, content style, and focus of the website.
- **Email Sending Automation**: Integrate with email platforms (e.g., Gmail, SendGrid) to send automated outreach emails with optional human-in-the-loop (HITL) review.
- **Lead Tracking and Management**: Track all emails sent, monitor replies, and keep track of successful backlinks. Log each lead’s status (e.g., emailed, responded, no reply) to manage future interactions.
- **Multiple Keywords/Queries**: Run the same process for a batch of keywords, automatically generating relevant search queries for each.
- **AI-Driven Follow-Up**: Schedule follow-up emails if there is no response after a specified period.
- **Reports and Analytics**: Provide users with reports on email performance metrics such as sent, opened, replied, and successful backlink placements.
## Core Workflow
1. **User Input**:
- **Keyword Search**: The user inputs a keyword (e.g., "AI writers").
- **Search Queries**: The app appends various search strings to this keyword to find backlinking opportunities (e.g., "AI writers + 'Write for Us'").
2. **Web Research**:
- Use search engines or web scraping to run multiple queries.
- Collect URLs of websites that have pages or posts related to guest post opportunities.
3. **Scrape Website Data**:
- **Contact Information Extraction**: Scrape the website for contact details (email addresses, contact forms, etc.).
- **Website Content Understanding**: Scrape a summary of each website’s content to personalize the email based on the site's focus.
4. **Personalized Outreach**:
- **AI Email Composition**: Compose personalized outreach emails based on the scraped data and user input.
- **Automated Email Sending**: Let users review and approve the personalized emails before they are sent, or allow full automation.
5. **Scaling the Search**:
- Repeat the same scraping and outreach process for a list of relevant keywords.
- Maintain a log of all sent emails, responses, and follow-up reminders.
6. **Tracking Responses and Follow-ups**:
- **Automated Responses**: Respond to positive replies with predefined follow-up emails.
- **Follow-up Reminders**: Send polite follow-up reminders at pre-set intervals if there is no reply.
## Prerequisites
- Python 3.6 or higher
- Required Python packages: `googlesearch-python`, `loguru`, `smtplib`, `email`
## Installation
1. Clone the repository:
```bash
git clone https://github.com/AJaySi/AI-Writer.git
cd AI-Writer
```
2. Install the required Python packages:
```bash
pip install -r requirements.txt
```
## Example Usage
```python
import os
from lib.ai_marketing_tools.ai_backlinking import main_backlinking_workflow
# SMTP and IMAP configurations
smtp_config = {
'server': 'smtp.gmail.com',
'port': 587,
'user': 'your_email@gmail.com',
'password': 'your_password'
}
imap_config = {
'server': 'imap.gmail.com',
'user': 'your_email@gmail.com',
'password': 'your_password'
}
# User proposal for guest posts
user_proposal = {
'user_name': 'Your Name',
'user_email': 'your_email@gmail.com',
'topic': 'Proposed guest post topic'
}
# Keywords for backlink opportunities
keywords = ['AI writers', 'content marketing', 'SEO tips']
# Run the main workflow
main_backlinking_workflow(keywords, smtp_config, imap_config, user_proposal)
```
### Functions
- `generate_search_queries(keyword)`: Generate a list of search queries for finding guest post opportunities.
- `find_backlink_opportunities(keyword)`: Find backlink opportunities by scraping websites based on search queries.
- `compose_personalized_email(website_data, insights, user_proposal)`: Compose a personalized outreach email using AI LLM based on website data, insights, and user proposal.
- `send_email(smtp_server, smtp_port, smtp_user, smtp_password, to_email, subject, body)`: Send an email using an SMTP server.
- `search_for_urls(query)`: Search for URLs based on a query using Firecrawl.
- `extract_contact_info(website_data)`: Extract contact information from website data.
- `find_backlink_opportunities_for_keywords(keywords)`: Find backlink opportunities for multiple keywords.
- `log_sent_email(keyword, email_info)`: Log the information of a sent email.
- `check_email_responses(imap_server, imap_user, imap_password)`: Check email responses using an IMAP server.
- `send_follow_up_email(smtp_server, smtp_port, smtp_user, smtp_password, to_email, subject, body)`: Send a follow-up email using an SMTP server.
- `main_backlinking_workflow(keywords, smtp_config, imap_config, user_proposal)`: Main workflow for the AI-powered backlinking feature.
## Contributing
Contributions are welcome! Please read the [contributing guidelines](CONTRIBUTING.md) first.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

117
lib/ai_marketing_tools/README.md Normal file
View File

@@ -0,0 +1,117 @@
---
# AI Backlinking Tool
## Overview
The `ai_backlinking.py` module is part of the [AI-Writer](https://github.com/AJaySi/AI-Writer) project. It simplifies and automates the process of finding and securing backlink opportunities. Using AI, the tool performs web research, extracts contact information, and sends personalized outreach emails for guest posting opportunities, making it an essential tool for content writers, digital marketers, and solopreneurs.
---
## Key Features
| Feature | Description |
|-------------------------------|-----------------------------------------------------------------------------|
| **Automated Web Scraping** | Extract guest post opportunities, contact details, and website insights. |
| **AI-Powered Emails** | Create personalized outreach emails tailored to target websites. |
| **Email Automation** | Integrate with platforms like Gmail or SendGrid for streamlined communication. |
| **Lead Management** | Track email status (sent, replied, successful) and follow up efficiently. |
| **Batch Processing** | Handle multiple keywords and queries simultaneously. |
| **AI-Driven Follow-Up** | Automate polite reminders if there's no response. |
| **Reports and Analytics** | View performance metrics like email open rates and backlink success rates. |
---
## Workflow Breakdown
| Step | Action | Example |
|-------------------------------|---------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------|
| **Input Keywords** | Provide keywords for backlinking opportunities. | *E.g., "AI tools", "SEO strategies", "content marketing."* |
| **Generate Search Queries** | Automatically create queries for search engines. | *E.g., "AI tools + 'write for us'" or "content marketing + 'submit a guest post.'"* |
| **Web Scraping** | Collect URLs, email addresses, and content details from target websites. | Extract "editor@contentblog.com" from "https://contentblog.com/write-for-us". |
| **Compose Outreach Emails** | Use AI to draft personalized emails based on scraped website data. | Email tailored to "Content Blog" discussing "AI tools for better content writing." |
| **Automated Email Sending** | Review and send emails or fully automate the process. | Send emails through Gmail or other SMTP services. |
| **Follow-Ups** | Automate follow-ups for non-responsive contacts. | A polite reminder email sent 7 days later. |
| **Track and Log Results** | Monitor sent emails, responses, and backlink placements. | View logs showing responses and backlink acquisition rate. |
---
## Prerequisites
- **Python Version**: 3.6 or higher.
- **Required Packages**: `googlesearch-python`, `loguru`, `smtplib`, `email`.
---
## Installation
1. Clone the repository:
```bash
git clone https://github.com/AJaySi/AI-Writer.git
cd AI-Writer
```
2. Install dependencies:
```bash
pip install -r requirements.txt
```
---
## Example Usage
Here’s a quick example of how to use the tool:
```python
from lib.ai_marketing_tools.ai_backlinking import main_backlinking_workflow
# Email configurations
smtp_config = {
'server': 'smtp.gmail.com',
'port': 587,
'user': 'your_email@gmail.com',
'password': 'your_password'
}
imap_config = {
'server': 'imap.gmail.com',
'user': 'your_email@gmail.com',
'password': 'your_password'
}
# Proposal details
user_proposal = {
'user_name': 'Your Name',
'user_email': 'your_email@gmail.com',
'topic': 'Proposed guest post topic'
}
# Keywords to search
keywords = ['AI tools', 'SEO strategies', 'content marketing']
# Start the workflow
main_backlinking_workflow(keywords, smtp_config, imap_config, user_proposal)
```
---
## Core Functions
| Function | Purpose |
|--------------------------------------------|-------------------------------------------------------------------------------------------|
| `generate_search_queries(keyword)` | Create search queries to find guest post opportunities. |
| `find_backlink_opportunities(keyword)` | Scrape websites for backlink opportunities. |
| `compose_personalized_email()` | Draft outreach emails using AI insights and website data. |
| `send_email()` | Send emails using SMTP configurations. |
| `check_email_responses()` | Monitor inbox for replies using IMAP. |
| `send_follow_up_email()` | Automate polite reminders to non-responsive contacts. |
| `log_sent_email()` | Keep a record of all sent emails and responses. |
| `main_backlinking_workflow()` | Execute the complete backlinking workflow for multiple keywords. |
---
## License
This project is licensed under the MIT License. For more details, refer to the [LICENSE](LICENSE) file.
---