Skip to content

Latest commit

 

History

History
112 lines (80 loc) · 2.2 KB

README.md

File metadata and controls

112 lines (80 loc) · 2.2 KB

CV Matcher

An intelligent system for matching job descriptions with candidate CVs/resumes using advanced text analysis and machine learning algorithms.

Features

  • Parse and analyze CVs in PDF and DOCX formats
  • Extract key information from job descriptions
  • Smart matching algorithm using ML/AI
  • REST API for integration
  • Scoring and ranking system

Prerequisites

  • Python 3.12+
  • Docker (optional)

Documentation

Quick Start

  1. Clone the repository:
git clone https://github.com/bigbag/cv_matcher.git
cd cv_matcher
  1. Set up a virtual environment and install dependencies:
make venv/create
make venv/install/all
  1. Set up environment variables:
cp env.example .local_env
# Edit .local_env with your configuration
  1. Run the application:
make run/server

The API will be available at http://localhost:8000

Using the Analyzer

To analyze a resume against a job description, use the following command:

make analyze RESUME_PATH=/path/to/resume.pdf JOB_DESC_PATH=/path/to/job.pdf

This command will:

  • Parse and analyze the provided resume
  • Extract requirements from the job description
  • Generate a matching score and detailed analysis

Docker Setup

  1. Build the image:
make docker/build/server
  1. Run the container:
make docker/run/server

API Documentation

Once the application is running, visit:

  • Swagger UI: http://localhost:8000/docs

Development

  1. Format code:
make format
  1. Run linters:
make lint
  1. Run tests:
make test
  1. Clean up temporary files and caches:
make clean

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

For support, please open an issue in the GitHub repository or contact the maintainers.