search

Sohammhatre10 / resume_scanner

Resume scanning and feature extraction using LLM endpoints
MIT License
3 stars 17 forks source link

Create resume_scanner.py #31

Closed agrawal-sneha closed 4 weeks ago

agrawal-sneha commented 4 weeks ago

Instructions for Resume Creation Script

Overview

The resume creation script has been modified to allow users to generate a structured resume in JSON format based on their provided information. Instead of scanning existing PDF or DOCX resumes, users can input their details directly into the command line.

Changes Made

  1. Removed Resume Scanning Functionality: The previous functionality for extracting text from PDF and DOCX files has been removed.
  2. User Input for Resume Creation: The script now accepts user-provided details about their resume directly as a command-line argument.
  3. New Prompt for Claude: The prompt sent to Claude (Anthropic's language model) has been updated to guide it in structuring the resume based on the provided details.
  4. Output: The generated resume is saved in a JSON format in a file named generated_resume.json.

Usage Instructions

  1. Set Up Your Environment:

    • Ensure you have Python installed on your machine.
    • Install the required packages if you haven't already: 
      pip install anthropic

  2. Set Your API Key:

    • Replace the placeholder in the script where the API key is set: 
      os.environ["ANTHROPIC_API_KEY"] = ""
    • You can also set your API key as an environment variable in your terminal or command prompt.

  3. Run the Script:

    • Use the command line to execute the script. Replace <user_input> with your resume details enclosed in quotes. For example: 
      python resume_scanner.py "Name: John Doe, Phone: 123-456-7890, Education: B.Tech in Computer Science from XYZ University, Skills: Python, Data Analysis, Experience: Intern at ABC Corp, Certifications: Certified Data Scientist"

  4. View the Output:

    • After running the script, a file named generated_resume.json will be created in the same directory as the script. This file contains the structured resume data in JSON format.
    • The console will also display the generated resume data for quick viewing.

  5. Check for Errors:

    • If there are any issues with the input or API response, appropriate error messages will be printed in the console for troubleshooting.

Example Command

Here's an example of how to run the script:

python resume_scanner.py "Name: Jane Smith, Phone: 987-654-3210, Education: B.Sc. in Information Technology from ABC University, Skills: Java, Machine Learning, Experience: Software Developer at XYZ Ltd, Certifications: AWS Certified Solutions Architect"
agrawal-sneha commented 4 weeks ago

This PR caters to issue https://github.com/Sohammhatre10/resume_scanner/issues/28