ChiragKaushikCK commited on
Commit
201fe27
Β·
verified Β·
1 Parent(s): 56df435

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +82 -6
README.md CHANGED
@@ -1,12 +1,88 @@
1
  ---
2
  title: Resume Analyzer Pro
3
- emoji: 😻
4
- colorFrom: gray
5
- colorTo: yellow
6
- sdk: docker
 
 
7
  pinned: false
8
  license: mit
9
- short_description: Resume_Analyzer_Pro
10
  ---
11
 
12
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  title: Resume Analyzer Pro
3
+ emoji: πŸ“„
4
+ colorFrom: blue
5
+ colorTo: purple
6
+ sdk: streamlit
7
+ sdk_version: 1.39.0
8
+ app_file: app.py
9
  pinned: false
10
  license: mit
 
11
  ---
12
 
13
+ # πŸ“„ Resume Analyzer Pro (Cinematic Edition)
14
+
15
+ A powerful, AI-driven resume optimization tool featuring a unique **Cinematic Live Transformation** viewer. This application analyzes resumes against job descriptions, provides scoring and feedback, and then rewrites the resume in real-time with a futuristic text-reveal animation.
16
+
17
+ ## ✨ Features
18
+
19
+ * **AI Analysis:** detailed breakdown of ATS scores, strengths, weaknesses, and missing keywords using Google Gemini.
20
+ * **Cinematic Enhancement:** Watch your resume be rewritten line-by-line in a sci-fi inspired "Live Transformation Viewer."
21
+ * **Format Support:** extracts text from **PDF** and **DOCX** files.
22
+ * **Targeted Optimization:** (Optional) Compare your resume against a specific Job Description.
23
+ * **Instant Download:** Export the enhanced version as a formatted `.docx` or plain `.txt`.
24
+
25
+ ## πŸš€ Setup & Deployment
26
+
27
+ ### 1. Prerequisites
28
+ You need a Google Gemini API Key. Get one for free at [Google AI Studio](https://aistudio.google.com/).
29
+
30
+ ### 2. Hugging Face Spaces Setup
31
+ If you are deploying this to a Hugging Face Space:
32
+
33
+ 1. Create a new Space (Select **Streamlit** as the SDK).
34
+ 2. Upload `app.py` and `requirements.txt`.
35
+ 3. Go to **Settings** > **Variables and secrets**.
36
+ 4. Click **New secret**.
37
+ * **Name:** `GEMINI_API_KEY`
38
+ * **Value:** *(Paste your Google Gemini API Key here)*
39
+ 5. The app will restart automatically with AI features enabled.
40
+
41
+ > **Note:** If no API key is provided, the app runs in "Demo Mode" using dummy data.
42
+
43
+ ### 3. Local Installation
44
+ To run this app on your own machine:
45
+
46
+ ```bash
47
+ # Clone the repository
48
+ git clone [https://huggingface.co/spaces/YOUR_USERNAME/YOUR_SPACE_NAME](https://huggingface.co/spaces/YOUR_USERNAME/YOUR_SPACE_NAME)
49
+ cd YOUR_SPACE_NAME
50
+
51
+ # Create a virtual environment
52
+ python -m venv venv
53
+ source venv/bin/activate # On Windows use: venv\Scripts\activate
54
+
55
+ # Install dependencies
56
+ pip install -r requirements.txt
57
+
58
+ # Set your API key (Linux/Mac)
59
+ export GEMINI_API_KEY="your_api_key_here"
60
+ # Or on Windows (PowerShell)
61
+ # $env:GEMINI_API_KEY="your_api_key_here"
62
+
63
+ # Run the app
64
+ streamlit run app.py
65
+
66
+ πŸ› οΈ Tech Stack
67
+ Frontend: Streamlit
68
+
69
+ AI Engine: Google Gemini (via google-generativeai)
70
+
71
+ Parsing: PyPDF2, python-docx, docx2txt
72
+
73
+ Visualization: Custom CSS & HTML animations
74
+
75
+ πŸ’‘ Usage Guide
76
+ Upload: Drag and drop your resume (PDF or DOCX) into the sidebar.
77
+
78
+ Context: (Optional) Paste the job description you are applying for.
79
+
80
+ Analyze: Click "Analyze Resume" to get your score and actionable feedback.
81
+
82
+ Transform: Click "Enhance & Play Cinematic Transformation".
83
+
84
+ Watch: Enjoy the animated rewrite in the main panel.
85
+
86
+ Download: Scroll down to download the polished Word document.
87
+
88
+ Built with ❀️ using Streamlit and Google Gemini.