Skip to content

Latest commit

 

History

History
606 lines (452 loc) · 26.3 KB

README.md

File metadata and controls

606 lines (452 loc) · 26.3 KB
Raw

AIHawk the first Jobs Applier AI Agent

CI

🤖🔍 Your AI-powered job search assistant. Automate applications, get personalized recommendations and land your dream job faster.

Join our community: Telegram (for Normal users) | Discord (for Open Source contributors)

Telegram Discord badge

Creator feder-cr, Co-Founder of AIHawk
As AIHawk is focusing on their proprietary product - solving problems in hiring for companies, currently this project is led, managed, and maintained by a group of open-source contributors, with a focus on building tools to help job seekers land the jobs they deserve.

Project Maintainers / Leads: surapuramakhil, sarob, cjbbb

We are looking to expand our FOSS maintainers team! If you are from a non-technical background, you can be part of the project management team, triaging issues, and shaping the project. If you are a technical person, you can join in doing code reviews, participating in releases, and building a better version of this product.

reach out to surapuramakhil on Discord. Special thanks

Auto_Jobs_Applier_AIHawk is continuously evolving, and your feedback, suggestions, and contributions are highly valued. Feel free to open issues, suggest enhancements, or submit pull requests to help improve the project. Let's work together to make Auto_Jobs_Applier_AIHawk a powerful tool for job seekers worldwide.

Table of Contents

  1. Introduction
  2. Features
  3. Installation
  4. Configuration
  5. Usage
  6. Documentation
  7. Troubleshooting
  8. Conclusion
  9. Contributors
  10. License
  11. Disclaimer

Introduction

Auto_Jobs_Applier_AIHawk is a cutting-edge, automated tool designed to revolutionize the job search and application process. In today's fiercely competitive job market, where opportunities can vanish in the blink of an eye, this program offers job seekers a significant advantage by leveraging the power of automation and artificial intelligence.

The Challenge of Modern Job Hunting

In the digital age, the job search landscape has undergone a dramatic transformation. While online platforms have opened up a world of opportunities, they have also intensified competition. Job seekers often find themselves spending countless hours scrolling through listings, tailoring applications, and repetitively filling out forms. This process can be not only time-consuming but also emotionally draining, leading to job search fatigue and missed opportunities.

Installation

Confirmed successful runs on the following:

  • Operating Systems:
    • Windows 10
    • Ubuntu 22
  • Python versions:
    • 3.10
    • 3.11.9(64b)
    • 3.12.5(64b)

Option 1: Using Python Virtual Environment

  1. Download and Install Python:

    Ensure you have the last Python version installed. If not, download and install it from Python's official website. For detailed instructions, refer to the tutorials:

  2. Download and Install Google Chrome:

    • Download and install the latest version of Google Chrome from its default location on the official website.

  3. Clone the repository:

    git clone https://github.com/code-infected/Auto_Jobs_Applier_AI_Agent.git

cd Auto_Jobs_Applier_AI_Agent

  4. Activate virtual environment:

    For Unix-based machines -

    python3 -m venv virtual
    source virtual/bin/activate

    or for Windows-based machines -

    .\virtual\Scripts\activate

  5. Install the required packages:

    Before installing the required packages, make sure to install https://visualstudio.microsoft.com/visual-cpp-build-tools/ and select "Desktop development with C++".

    pip install -r requirements.txt

Configuration

1. secrets.yaml

This file contains sensitive information. Never share or commit this file to version control.

  • llm_api_key: [Your OpenAI or Ollama API key or Gemini API key]
    • Replace with your OpenAI API key for GPT integration
    • To obtain an API key, follow the tutorial at: https://medium.com/@lorenzozar/how-to-get-your-own-openai-api-key-f4d44e60c327
    • Note: You need to add credit to your OpenAI account to use the API. You can add credit by visiting the OpenAI billing dashboard.
    • According to the OpenAI community and our users' reports, right after setting up the OpenAI account and purchasing the required credits, users still have a Free account type. This prevents them from having unlimited access to OpenAI models and allows only 200 requests per day. This might cause runtime errors such as:
      Error code: 429 - {'error': {'message': 'You exceeded your current quota, please check your plan and billing details. ...}}
      {'error': {'message': 'Rate limit reached for gpt-4o-mini in organization <org> on requests per day (RPD): Limit 200, Used 200, Requested 1.}}
      OpenAI will update your account automatically, but it might take some time, ranging from a couple of hours to a few days.
      You can find more about your organization's limits on the official page.
    • For obtaining Gemini API key visit Google AI for Devs

1.1 config.py - Customize LLM model endpoint

2. plain_text_resume.yaml

This file contains your resume information in a structured format. Fill it out with your personal details, education, work experience, and skills. This information is used to auto-fill application forms and generate customized resumes.

Each section has specific fields to fill out:

  • personal_information:

    • This section contains basic personal details to identify yourself and provide contact information.
      • name: Your first name.
      • surname: Your last name or family name.
      • date_of_birth: Your birth date in the format DD/MM/YYYY.
      • country: The country where you currently reside.
      • city: The city where you currently live.
      • address: Your full address, including street and number.
      • zip_code: Your postal/ZIP code.
      • phone_prefix: The international dialing code for your phone number (e.g., +1 for the USA, +44 for the UK).
      • phone: Your phone number without the international prefix.
      • email: Your primary email address.
      • github: URL to your GitHub profile, if applicable.
      • linkedin: URL to your LinkedIn profile, if applicable.
    • Example
    personal_information:
  name: "Jane"
  surname: "Doe"
  date_of_birth: "01/01/1990"
  country: "USA"
  city: "New York"
  address: "123 Main St"
  zip_code: "520123"
  phone_prefix: "+1"
  phone: "5551234567"
  email: "[email protected]"
  github: "https://github.com/janedoe"
  linkedin: "https://www.linkedin.com/in/janedoe/"

  • education_details:

    • This section outlines your academic background, including degrees earned and relevant coursework.

      • degree: The type of degree obtained (e.g., Bachelor's Degree, Master's Degree).
      • university: The name of the university or institution where you studied.
      • final_evaluation_grade: Your Grade Point Average or equivalent measure of academic performance.
      • start_date: The start year of your studies.
      • graduation_year: The year you graduated.
      • field_of_study: The major or focus area of your studies.
      • exam: A list of courses or subjects taken along with their respective grades.

    • Example:

    education_details:
  - education_level: "Bachelor's Degree"
    institution: "University of Example"
    field_of_study: "Software Engineering"
    final_evaluation_grade: "4/4"
    start_date: "2021"
    year_of_completion: "2023"
    exam:
      Algorithms: "A"
      Data Structures: "B+"
      Database Systems: "A"
      Operating Systems: "A-"
      Web Development: "B"

  • experience_details:

    • This section details your work experience, including job roles, companies, and key responsibilities.

      • position: Your job title or role.
      • company: The name of the company or organization where you worked.
      • employment_period: The timeframe during which you were employed in the role, using the format MM/YYYY - MM/YYYY.
      • location: The city and country where the company is located.
      • industry: The industry or field in which the company operates.
      • key_responsibilities: A list of major responsibilities or duties you had in the role, e.g. responsibility: "Developed web applications using React and Node.js".
      • skills_acquired: Skills or expertise gained through this role, e.g. "React".

    • Example:

    experience_details:
  - position: "Software Developer"
    company: "Tech Innovations Inc."
    employment_period: "06/2021 - Present"
    location: "San Francisco, CA"
    industry: "Technology"
    key_responsibilities:
      - responsibility: "Developed web applications using React and Node.js"
      - responsibility: "Collaborated with cross-functional teams to design and implement new features"
      - responsibility: "Troubleshot and resolved complex software issues"
    skills_acquired:
      - "React"
      - "Node.js"
      - "Software Troubleshooting"

  • projects:

    • Include notable projects you have worked on, including personal or professional projects.

      • name: The name or title of the project.
      • description: A brief summary of what the project involves or its purpose.
      • link: URL to the project, if available (e.g., GitHub repository, website).

    • Example:

      projects:
  - name: "Weather App"
    description: "A web application that provides real-time weather information using a third-party API."
    link: "https://github.com/janedoe/weather-app"
  - name: "Task Manager"
    description: "A task management tool with features for tracking and prioritizing tasks."
    link: "https://github.com/janedoe/task-manager"

  • achievements:

    • Highlight notable accomplishments or awards you have received.

      • name: The title or name of the achievement.
      • description: A brief explanation of the achievement and its significance.

    • Example:

    achievements:
  - name: "Employee of the Month"
    description: "Recognized for exceptional performance and contributions to the team."
  - name: "Hackathon Winner"
    description: "Won first place in a national hackathon competition."

  • certifications:

    • Include any professional certifications you have earned.

      • name: "PMP"
        description: "Certification for project management professionals, issued by the Project Management Institute (PMI)"

    • Example:

    certifications:
  - "Certified Scrum Master"
  - "AWS Certified Solutions Architect"

  • languages:

    • Detail the languages you speak and your proficiency level in each.

      • language: The name of the language.
      • proficiency: Your level of proficiency (e.g., Native, Fluent, Intermediate).

    • Example:

    languages:
  - language: "English"
    proficiency: "Fluent"
  - language: "Spanish"
    proficiency: "Intermediate"

  • interests:

    • Mention your professional or personal interests that may be relevant to your career.

      • interest: A list of interests or hobbies.

    • Example:

    interests:
  - "Machine Learning"
  - "Cybersecurity"
  - "Open Source Projects"
  - "Digital Marketing"
  - "Entrepreneurship"

  • availability:

    • State your current availability or notice period.

      • notice_period: The amount of time required before you can start a new role (e.g., "2 weeks", "1 month").

    • Example:

    availability:
  notice_period: "2 weeks"

  • salary_expectations:

    • Provide your expected salary range.

      • salary_range_usd: The salary range you are expecting, expressed in USD.

    • Example:

    salary_expectations:
  salary_range_usd: "80000 - 100000"

  • self_identification:

    • Provide information related to personal identity, including gender and pronouns.

      • gender: Your gender identity.
      • pronouns: The pronouns you use (e.g., He/Him, She/Her, They/Them).
      • veteran: Your status as a veteran (e.g., Yes, No).
      • disability: Whether you have a disability (e.g., Yes, No).
      • ethnicity: Your ethnicity.

    • Example:

    self_identification:
  gender: "Female"
  pronouns: "She/Her"
  veteran: "No"
  disability: "No"
  ethnicity: "Asian"

  • legal_authorization:

    • Indicate your legal ability to work in various locations.

      • eu_work_authorization: Whether you are authorized to work in the European Union (Yes/No).
      • us_work_authorization: Whether you are authorized to work in the United States (Yes/No).
      • requires_us_visa: Whether you require a visa to work in the United States (Yes/No).
      • requires_us_sponsorship: Whether you require sponsorship to work in the United States (Yes/No).
      • requires_eu_visa: Whether you require a visa to work in the European Union (Yes/No).
      • legally_allowed_to_work_in_eu: Whether you are legally allowed to work in the European Union (Yes/No).
      • legally_allowed_to_work_in_us: Whether you are legally allowed to work in the United States (Yes/No).
      • requires_eu_sponsorship: Whether you require sponsorship to work in the European Union (Yes/No).
      • canada_work_authorization: Whether you are authorized to work in Canada (Yes/No).
      • requires_canada_visa: Whether you require a visa to work in Canada (Yes/No).
      • legally_allowed_to_work_in_canada: Whether you are legally allowed to work in Canada (Yes/No).
      • requires_canada_sponsorship: Whether you require sponsorship to work in Canada (Yes/No).
      • uk_work_authorization: Whether you are authorized to work in the United Kingdom (Yes/No).
      • requires_uk_visa: Whether you require a visa to work in the United Kingdom (Yes/No).
      • legally_allowed_to_work_in_uk: Whether you are legally allowed to work in the United Kingdom (Yes/No).
      • requires_uk_sponsorship: Whether you require sponsorship to work in the United Kingdom (Yes/No).

    • Example:

      legal_authorization:
eu_work_authorization: "Yes"
us_work_authorization: "Yes"
requires_us_visa: "No"
requires_us_sponsorship: "Yes"
requires_eu_visa: "No"
legally_allowed_to_work_in_eu: "Yes"
legally_allowed_to_work_in_us: "Yes"
requires_eu_sponsorship: "No"
canada_work_authorization: "Yes"
requires_canada_visa: "No"
legally_allowed_to_work_in_canada: "Yes"
requires_canada_sponsorship: "No"
uk_work_authorization: "Yes"
requires_uk_visa: "No"
legally_allowed_to_work_in_uk: "Yes"
requires_uk_sponsorship: "No"

  • work_preferences:

    • Specify your preferences for work arrangements and conditions.

      • remote_work: Whether you are open to remote work (Yes/No).
      • in_person_work: Whether you are open to in-person work (Yes/No).
      • open_to_relocation: Whether you are willing to relocate for a job (Yes/No).
      • willing_to_complete_assessments: Whether you are willing to complete job assessments (Yes/No).
      • willing_to_undergo_drug_tests: Whether you are willing to undergo drug testing (Yes/No).
      • willing_to_undergo_background_checks: Whether you are willing to undergo background checks (Yes/No).

    • Example:

    work_preferences:
  remote_work: "Yes"
  in_person_work: "No"
  open_to_relocation: "Yes"
  willing_to_complete_assessments: "Yes"
  willing_to_undergo_drug_tests: "No"
  willing_to_undergo_background_checks: "Yes"

PLUS. data_folder_example

The data_folder_example folder contains a working example of how the files necessary for the bot's operation should be structured and filled out. This folder serves as a practical reference to help you correctly set up your work environment for the job search bot.

Contents

Inside this folder, you'll find example versions of the key files:

  • secrets.yaml
  • plain_text_resume.yaml

These files are already populated with fictitious but realistic data. They show you the correct format and type of information to enter in each file.

Using the data_folder_example

Using this folder as a guide can be particularly helpful for:

  1. Understanding the correct structure of each configuration file
  2. Seeing examples of valid data for each field
  3. Having a reference point while filling out your personal files

Usage

  1. Data Folder: Ensure that your data_folder contains the following files:

    • secrets.yaml
    • plain_text_resume.yaml

  2. Output Folder: Contains the output of the bot. TODO

  3. Run the Bot:

    Auto_Jobs_Applier_AIHawk offers flexibility in how it handles your PDF resume:

  • Resume and Cover Letter Generation:

    python main.py

Troubleshooting

1. OpenAI API Rate Limit Errors

Error Message:

openai.RateLimitError: Error code: 429 - {'error': {'message': 'You exceeded your current quota, please check your plan and billing details. For more information on this error, read the docs: https://platform.openai.com/docs/guides/error-codes/api-errors.', 'type': 'insufficient_quota', 'param': None, 'code': 'insufficient_quota'}}

Solution:

  • Check your OpenAI API billing settings at https://platform.openai.com/account/billing
  • Ensure you have added a valid payment method to your OpenAI account
  • Note that ChatGPT Plus subscription is different from API access
  • If you've recently added funds or upgraded, wait 12-24 hours for changes to take effect
  • Free tier has a 3 RPM limit; spend at least $5 on API usage to increase

2. Incorrect Information in Job Applications

Issue: Bot provides inaccurate data for experience, CTC, and notice period

Solution:

  • Update prompts for professional experience specificity
  • Add fields in config.py for current CTC, expected CTC, and notice period
  • Modify bot logic to use these new config fields

3. YAML Configuration Errors

Error Message:

yaml.scanner.ScannerError: while scanning a simple key

Solution:

  • Copy example config.yaml and modify gradually
  • Ensure proper YAML indentation and spacing
  • Use a YAML validator tool
  • Avoid unnecessary special characters or quotes

General Troubleshooting Tips

  • Use the latest version of the script
  • Verify all dependencies are installed and updated
  • Check internet connection stability
  • Clear browser cache and cookies if issues persist

For further assistance, please create an issue on the GitHub repository with detailed information about your problem, including error messages and your configuration (with sensitive information removed).

Documentation

For Users

  • Ollama Setup

    • Follow the instructions beloe to ensure proper configuration of AIHawk with Ollama and Gemini.
    • Written by Rushi, Linkedin, support him by following.
    • Step 1: If your system meets the requirements for Ollama, install it from the following URL https://ollama.com/download.
    • Step 2: Verify Ollama is Running
      • Open a browser and navigate to localhost:11434 to confirm Ollama is running
    • If Ollama runs correctly, you'll see confirmation in the browser.
    • Step 3: Edit Configuration in VS Code
      • Edit the file config.py located at Auto_Jobs_Applier_AIHawk\config.py with the following
      • llm_model_type: ollama
      • llm_model: 'llama3.2:1b'
      • llm_api_url: 'http://127.0.0.1:11434/'

  • Gemini Setup

    • Follow the instructions beloe to ensure proper configuration of AIHawk with Ollama and Gemini.
    • Written by Rushi, Linkedin, support him by following.
    • Step 1: Get your free API key at https://aistudio.google.com/app/apikey.
    • Step 2: Verify Ollama is Running
      • Replace llm_api_key with your newly created API key on the file secrets.yaml located at Auto_Jobs_Applier_AIHawk\data_folder\secrets.yaml
    • Step 2: Verify Ollama is Running
      • Replace llm_api_key with your newly created API key on the file secrets.yaml located at Auto_Jobs_Applier_AIHawk\data_folder\secrets.yaml
    • Step 3: Edit Configuration in VS Code
      • Edit the file config.py located at Auto_Jobs_Applier_AIHawk\config.py with the following
      • llm_model_type: gemini
      • llm_model: 'gemini-pro'

  • Editing YAML Files

  • Auto-start AIHawk

  • Video Tutorial

  • OpenAI API Documentation

For Developers

  • Contribution Guidelines

  • Lang Chain Developer Documentation

  • If you encounter any issues, you can open an issue on GitHub. Please add valuable details to the subject and to the description. If you need a new feature then please reflect this.
    I'll be more than happy to assist you!

  • Note for Contributors: If you would like to submit a Pull Request (PR), please target the release branch instead of main. The release branch is used for testing new code changes and will be periodically merged into main after validation. This approach ensures that only tested features are included in the main branch.

Conclusion

Auto_Jobs_Applier_AIHawk provides a significant advantage in the modern job market by automating and enhancing the job application process. With features like dynamic resume generation and AI-powered personalization, it offers unparalleled flexibility and efficiency. Whether you're a job seeker aiming to maximize your chances of landing a job, a recruiter looking to streamline application submissions, or a career advisor seeking to offer better services, Auto_Jobs_Applier_AIHawk is an invaluable resource. By leveraging cutting-edge automation and artificial intelligence, this tool not only saves time but also significantly increases the effectiveness and quality of job applications in today's competitive landscape.

Star History

Star History Chart

If you like the project please star ⭐ the repository!

Special Thanks

Contributors

Made with contrib.rocks.

License

This project is licensed under the AGPL License. Documentation is licensed under CC BY - see the AGPL LICENSE and CC BY LICENSE files for details.

The AGPL License requires that any derivative work must also be open source and distributed under the same license.

The CC BY License permits others to distribute, remix, adapt, and build upon your work, even for commercial purposes, as long as they credit you for the original creation.

Disclaimer

This tool, Auto_Jobs_Applier_AIHawk, is intended for use at your own risk. The creators / maintainers / contributors assume no responsibility for any consequences arising from its use. Users are advised to comply with the terms of service of relevant platforms and adhere to all applicable laws, regulations, and ethical guidelines. The use of automated tools for job applications may carry risks, including potential impacts on user accounts. Proceed with caution and at your own discretion.

Back to top 🚀