Himanshu2003 commited on
Commit
e58c59f
·
verified ·
1 Parent(s): ce2d413

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +49 -24
README.md CHANGED
@@ -1,7 +1,7 @@
1
  ---
2
  title: NeoPitch
3
  emoji: ⚡
4
- colorFrom: red
5
  colorTo: red
6
  sdk: docker
7
  app_port: 8501
@@ -11,43 +11,68 @@ pinned: false
11
  short_description: High-speed, smart job email generation.
12
  ---
13
 
14
- # ⚡ NeoPitch ✉️
 
15
 
16
- "Turn job descriptions and your resume into perfect cold emails in seconds!"
 
 
 
 
 
 
 
 
17
 
18
  ---
19
 
20
- ## Overview
 
 
 
 
21
 
22
- **NeoPitch** is a Streamlit-powered web application that helps job seekers craft personalized, professional cold emails for job applications. By leveraging advanced AI models via LangChain and Groq's ChatGroq API, the app can:
 
 
23
 
24
- - Scrape job postings from URLs or accept pasted job descriptions.
25
- - Parse resumes from uploaded PDF/TXT files or pasted text.
26
- - Extract structured information (like role, experience, skills, projects, courses, and certifications) from both job postings and resumes.
27
- - Generate a concise, tailored cold email for a hiring manager, highlighting your most relevant skills and experiences.
28
 
29
- This eliminates the guesswork in writing cold emails and helps you present yourself professionally, quickly, and effectively.
 
 
 
30
 
31
  ---
32
 
33
- ## Features
34
 
35
- - **Job Description Input**
36
- - Paste job description text or fetch from a URL.
37
- - Automatically extracts key job details in structured JSON.
38
 
39
- - **Resume Input**
40
- - Upload your resume (PDF/TXT) or paste the content directly.
41
- - Automatically extracts personal info, skills, experience, projects, courses, and certifications.
42
 
43
- - **Cold Email Generation**
44
- - AI-generated emails tailored to the job and your resume.
45
- - Professional, natural, and concise (under 400 words).
46
- - One-click copy/download functionality.
47
 
48
- - **User-Friendly Interface**
49
- - Clean Streamlit interface with step-by-step guidance.
50
- - Real-time feedback while processing.
 
51
 
 
52
 
 
 
 
 
 
 
 
 
53
 
 
1
  ---
2
  title: NeoPitch
3
  emoji: ⚡
4
+ colorFrom: purple
5
  colorTo: red
6
  sdk: docker
7
  app_port: 8501
 
11
  short_description: High-speed, smart job email generation.
12
  ---
13
 
14
+ # ⚡ NeoPitch ✉️
15
+ ### Turn job descriptions and your resume into perfect cold emails in seconds!
16
 
17
+ ---
18
+
19
+ ## 🧠 Overview
20
+
21
+ **NeoPitch** is an AI-powered web app built with **Streamlit**, designed to help job seekers instantly craft **personalized and professional cold emails** for job applications.
22
+
23
+ By combining the power of **LangChain** and **Groq’s ChatGroq API**, NeoPitch intelligently analyzes both **job descriptions** and **resumes** to create highly relevant, recruiter-ready emails — in seconds.
24
+
25
+ The app eliminates the guesswork and time spent drafting outreach messages, helping users **stand out professionally and communicate effectively** with hiring managers.
26
 
27
  ---
28
 
29
+ ## ✨ Features
30
+
31
+ ### 🧾 Job Description Input
32
+ - Paste a job description directly or provide a job post URL.
33
+ - Automatically extracts and structures key details like role, experience level, and required skills.
34
 
35
+ ### 📄 Resume Input
36
+ - Upload your **resume** (PDF or TXT) or paste its content directly.
37
+ - AI parses your resume to identify personal information, skills, work experience, projects, courses, and certifications.
38
 
39
+ ### 💌 Cold Email Generation
40
+ - Generates **AI-written cold emails** that highlight your most relevant skills and experiences.
41
+ - Emails are **professional, concise**, and **context-aware** (under ~400 words).
42
+ - Offers one-click copy and download options for convenience.
43
 
44
+ ### 🎯 User-Friendly Interface
45
+ - Simple, intuitive Streamlit UI for smooth workflow.
46
+ - Step-by-step interaction: job input → resume input → email generation.
47
+ - Displays real-time feedback while processing content.
48
 
49
  ---
50
 
51
+ ## ⚙️ How It Works
52
 
53
+ 1. **Job Input**
54
+ - User provides a job description (via text or URL).
55
+ - The app extracts structured details like job title, company, and key requirements.
56
 
57
+ 2. **Resume Parsing**
58
+ - Uploaded resume (PDF/TXT) is processed to extract relevant data such as education, projects, and skills.
 
59
 
60
+ 3. **AI-Powered Matching**
61
+ - NeoPitch compares both data sources to identify overlaps and strengths.
 
 
62
 
63
+ 4. **Cold Email Generation**
64
+ - The **ChatGroq AI model** generates a tailored, natural-sounding cold email that emphasizes your best fit for the role.
65
+
66
+ ---
67
 
68
+ ## 🧩 Tech Stack
69
 
70
+ | Component | Technology / Library | Purpose |
71
+ |------------|----------------------|----------|
72
+ | 🧱 Frontend & UI | **Streamlit** | Builds the user-friendly web interface |
73
+ | 🧠 AI & Orchestration | **LangChain** | Manages prompt flow and LLM pipelines |
74
+ | ⚡ LLM Engine | **Groq ChatGroq API** | Provides ultra-fast AI text generation |
75
+ | 📄 Resume Parsing | **PyPDF2**, **LangChain** | Extracts text and structure from resumes |
76
+ | 🌐 Web Scraping | **BeautifulSoup4**, **Requests** | Fetches job descriptions from URLs |
77
+ | 💾 Language | **Python 3.11+** | Core development language |
78