Skip to content

tusyaa04/Cold_Email_Generator

Repository files navigation

Here's the README.md file code ready to paste:

📧 Cold Email Generator

Cold Email Generator is a Streamlit-based application that automates the creation of personalized and professional emails. It is designed for job applications, follow-ups, and professional networking, leveraging AI and ChromaDB to create highly relevant and engaging email drafts.

Features

  • Dynamic Email Purposes: Generate emails for:
    • Job Inquiries
    • Application Follow-ups
    • Professional Networking
  • Customizable Email Tone: Choose from Formal, Casual, or Friendly tones for a personalized communication style.
  • Job Description Parsing: Extracts structured job details from URLs for precise email generation (for Job Inquiry and Application Follow-up purposes).
  • Portfolio Integration: Uses ChromaDB to match skills and projects from your portfolio to the email's purpose.
  • Networking Emails: Generate professional networking emails without requiring a Job URL.

Technologies Used

  • Python: Core programming language.
  • Streamlit: For an interactive user interface.
  • LangChain: Manages the AI pipeline for text generation.
  • LLM (Large Language Models): Generates email content.
  • WebBaseLoader: Parses content from job pages (for Job Inquiry and Application Follow-up).
  • ChromaDB: Vector database for efficient portfolio queries.

Prerequisites

Ensure the following are installed:

  • Python 3.8+
  • pip (Python package manager)
  • Streamlit
  • LangChain
  • ChromaDB
  • dotenv

Installation

  1. Clone the repository:
    git clone https://github.com/your-username/cold-email-generator.git
    cd cold-email-generator
    
  2. Install required dependencies:

pip install -r requirements.txt

  1. Set up environment variables:

Create a .env file in the project directory.

Add your API key for the language model:

GROQ_API_KEY=your_groq_api_key

Usage

  1. Start the Streamlit app:

streamlit run mains.py

  1. Open your browser and navigate to the local server URL (e.g., http://localhost:8501).

  2. Provide the following inputs:

Profile Summary: A short summary of your skills and expertise for tailoring the email.

Email Tone: Choose from Formal, Casual, or Friendly.

Purpose of Email: Select one from:

Job Inquiry

Application Follow-up

Networking

Job URL (Required for Job Inquiry and Application Follow-up): The URL of the job posting.

  1. For Networking, the Job URL is not required. Simply provide your Profile Summary and desired Email Tone, and the app will generate an email focused on professional connections, advice, or opportunities.

  2. Click Generate Cold Email to get your personalized email. Screenshot (101) Screenshot (110)

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published