-
Notifications
You must be signed in to change notification settings - Fork 5
Home
Gaurav-Kumar98 edited this page Mar 24, 2025
·
2 revisions
Welcome to the Resume Analysis project wiki! This documentation will help you understand, set up, and use the Resume Analysis tool effectively.
Resume Analysis is a powerful Python-based application designed to streamline the resume review process. It automatically extracts and analyzes information from PDF and DOCX resumes using Google's Gemini Large Language Models (LLMs). The system features a flexible plugin architecture that makes it easy to extend its functionality.
- Plugin-Based Architecture: Extend functionality by adding new plugins
- Multiple Resume Formats: Support for PDF and DOCX files
-
Comprehensive Information Extraction:
- Basic profile information
- Skills analysis
- Education history
- Work experience
- Years of experience calculation
-
Efficient Processing:
- Concurrent processing of multiple aspects
- Structured JSON output
- Token usage tracking and optimization
-
Robust Logging:
- Separate log files for different purposes
- Automatic log rotation
- Configurable log retention
- Clone the repository
- Set up your environment:
python -m venv .venv source .venv/bin/activate # Linux/Mac .venv\Scripts\activate # Windows pip install -r requirements.txt
- Configure your environment:
cp .env.example .env # Edit .env with your API keys and preferences - Process resumes:
python main.py
- Installation & Setup - Detailed setup instructions
- User Guide - How to use the tool effectively
- Plugin System - Understanding and extending the plugin architecture
- Technical Documentation - Internal implementation details
- Examples & Tutorials - Practical usage examples
- Contributing - How to contribute to the project
- FAQ & Troubleshooting - Common issues and solutions
- Check the FAQ & Troubleshooting page for common issues
- Review the Examples & Tutorials for usage patterns
- Open an issue on GitHub for bug reports or feature requests
- Join our community discussions
This project is licensed under the MIT License - see the LICENSE file for details.