From 28cb85af742f10dded17ac6315c85c225a052cff Mon Sep 17 00:00:00 2001 From: Federico <85809106+feder-cr@users.noreply.github.com> Date: Sat, 10 Aug 2024 19:24:47 +0100 Subject: [PATCH 1/4] Update README.md --- README.md | 164 +++++++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 145 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 8ff17f5..73a8bf1 100644 --- a/README.md +++ b/README.md @@ -91,37 +91,163 @@ LinkedIn_AIHawk steps in as a game-changing solution to these challenges. It's n ## Configuration -LinkedIn_AIHawk relies on three main configuration files: - ### 1. secrets.yaml -Contains sensitive information. Never share or commit this file to version control. +This file contains sensitive information. Never share or commit this file to version control. -- `email`: Your LinkedIn account email -- `password`: Your LinkedIn account password -- `openai_api_key`: Your OpenAI API key for GPT integration +- `email: [Your LinkedIn email]` + - Replace with your LinkedIn account email address +- `password: [Your LinkedIn password]` + - Replace with your LinkedIn account password +- `openai_api_key: [Your OpenAI 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 ### 2. config.yaml -Defines your job search parameters and bot behavior. +This file defines your job search parameters and bot behavior. Each section contains options that you can customize: -- `remote`: Set to `true` to include remote jobs, `false` to exclude them -- `experienceLevel`: Set desired experience levels to `true` -- `jobTypes`: Set desired job types to `true` -- `date`: Choose one time range for job postings -- `positions`: List job titles you're interested in -- `locations`: List locations you want to search in -- `distance`: Set the radius for your job search (in miles) -- `companyBlacklist`: List companies you want to exclude from your search -- `titleBlacklist`: List keywords in job titles you want to avoid +- `remote: [true/false]` + - Set to `true` to include remote jobs, `false` to exclude them -### 3. plain_text_resume_template.yaml +- `experienceLevel:` + - Set desired experience levels to `true`, others to `false` + - Options: `internship`, `entry`, `associate`, `mid-senior level`, `director`, `executive` + - Example: `internship: true` -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. +- `jobTypes:` + - Set desired job types to `true`, others to `false` + - Options: `full-time`, `contract`, `part-time`, `temporary`, `internship`, `other`, `volunteer` + - Example: `full-time: true` + +- `date:` + - Choose one time range for job postings by setting it to `true`, others to `false` + - Options: `all time`, `month`, `week`, `24 hours` + - Example: `month: true` + +- `positions:` + - List job titles you're interested in, one per line + - Example: + ```yaml + positions: + - Software Developer + - Data Scientist + ``` + +- `locations:` + - List locations you want to search in, one per line + - Example: + ```yaml + locations: + - New York, USA + - London, UK + ``` + +- `distance: [number]` + - Set the radius for your job search in miles + - Example: `distance: 50` + +- `companyBlacklist:` + - List companies you want to exclude from your search, one per line + - Example: + ```yaml + companyBlacklist: + - Company X + - Company Y + ``` + +- `titleBlacklist:` + - List keywords in job titles you want to avoid, one per line + - Example: + ```yaml + titleBlacklist: + - Sales + - Marketing + ``` + +### 3. 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:` + - Contains basic personal details + - Example: `name: "John Doe"` + +- `self_identification:` + - Optional demographic information + - Example: `gender: "Male"` + +- `legal_authorization:` + - Work authorization status + - Use `true` or `false` for each field + - Example: `usWorkAuthorization: true` + +- `work_preferences:` + - Your work-related preferences + - Use `true` or `false` for each field + - Example: `remoteWork: true` + +- `education_details:` + - List your educational background + - Include degree, university, GPA, graduation year, field of study, and skills acquired + - Example: + ```yaml + - degree: "Bachelor's" + university: "University of Example" + gpa: "3.8" + graduationYear: "2022" + fieldOfStudy: "Computer Science" + skillsAcquired: + problemSolving: "4" + ``` + +- `experience_details:` + - List your work experiences + - Include position, company, employment period, location, industry, key responsibilities, and skills acquired + - Example: + ```yaml + - position: "Software Developer" + company: "Tech Corp" + employmentPeriod: "Jan 2020 - Present" + location: "San Francisco, USA" + industry: "Technology" + keyResponsibilities: + responsibility1: "Developed web applications using React" + skillsAcquired: + adaptability: "3" + ``` + +- Other sections like `projects`, `availability`, `salary_expectations`, `certifications`, `skills`, `languages`, and `interests` follow a similar format, with each item on a new line. + +### 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 LinkedIn job search bot. + +#### Contents + +Inside this folder, you'll find example versions of the key files: + +- `secrets.yaml` +- `config.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. + +#### Usage + +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 + +#### Important Note ## Usage -1. **Prepare the Data Folder:** +1. **Data Folder:** Ensure that your data_folder contains the following files: - `secrets.yaml` - `config.yaml` From 4342eea595896f53a9b440cce7905a02f7c061fe Mon Sep 17 00:00:00 2001 From: Federico <85809106+feder-cr@users.noreply.github.com> Date: Sat, 10 Aug 2024 19:26:02 +0100 Subject: [PATCH 2/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 73a8bf1..92697b0 100644 --- a/README.md +++ b/README.md @@ -221,7 +221,7 @@ Each section has specific fields to fill out: - Other sections like `projects`, `availability`, `salary_expectations`, `certifications`, `skills`, `languages`, and `interests` follow a similar format, with each item on a new line. -### data_folder_example +### 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 LinkedIn job search bot. From 11da2984c30d8edc034a37c7d1d8cda9ae331ba6 Mon Sep 17 00:00:00 2001 From: Federico <85809106+feder-cr@users.noreply.github.com> Date: Sat, 10 Aug 2024 23:13:02 +0100 Subject: [PATCH 3/4] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 92697b0..fc83d2e 100644 --- a/README.md +++ b/README.md @@ -279,6 +279,8 @@ For detailed information on each component and their respective roles, please re - **Missing Files:** Verify that all necessary files are present in the data folder. - **Invalid YAML:** Check your YAML files for syntax errors. + If you encounter any issues, you can open an issue on [GitHub](https://github.com/feder-cr/linkedIn_auto_jobs_applier_with_AI/issues). I'll be more than happy to assist you! + ## Conclusion LinkedIn_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, LinkedIn_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. From 40b8f711be7f08c6a85c1418fe50cb58f65505db Mon Sep 17 00:00:00 2001 From: Federico <85809106+feder-cr@users.noreply.github.com> Date: Sat, 10 Aug 2024 23:15:22 +0100 Subject: [PATCH 4/4] Update README.md --- README.md | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index fc83d2e..70b7ccf 100644 --- a/README.md +++ b/README.md @@ -112,18 +112,13 @@ This file defines your job search parameters and bot behavior. Each section cont - `experienceLevel:` - Set desired experience levels to `true`, others to `false` - - Options: `internship`, `entry`, `associate`, `mid-senior level`, `director`, `executive` - - Example: `internship: true` - `jobTypes:` - Set desired job types to `true`, others to `false` - - Options: `full-time`, `contract`, `part-time`, `temporary`, `internship`, `other`, `volunteer` - - Example: `full-time: true` - `date:` - Choose one time range for job postings by setting it to `true`, others to `false` - - Options: `all time`, `month`, `week`, `24 hours` - - Example: `month: true` + - `positions:` - List job titles you're interested in, one per line @@ -139,8 +134,8 @@ This file defines your job search parameters and bot behavior. Each section cont - Example: ```yaml locations: - - New York, USA - - London, UK + - Itally + - London ``` - `distance: [number]`