Skip to content

Empowers users to create custom resume or cover-leter latex templates using Python πŸ’»

License

Notifications You must be signed in to change notification settings

rishi23root/resume-curator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Resume curator 🎯

LaTeX-Python Resume Curator πŸš€ Empowers users to create custom resume or cover-letter LaTeX templates using Python πŸ’» An automated Python-LaTeX workflow to curate resumes. Create your own templates and build your unique resume with LaTeX and Python πŸ’»

Key Features:

  • Utilizes successful templates for inspiration πŸ“„
  • Provides a tool to easily convert LaTeX ideas to PDF πŸ“„
  • access to create new custom templates
  • access to modify the existing templates

API Integration:

  • HTTP API for seamless and convenient access πŸš€
  • Checkout path /swagger for full API documentation πŸ“–

To Run Project β“πŸ”»

  • clone the repo πŸ‘―β€β™€οΈ

To Running on local env

  • execute scripts/setup.sh script to install dependencies and setup the environment

    ./scripts/setup.sh
    • updating your system apt packages
    • install texlive (smallest version possible to run pdflatex)
    • updating pip
    • setup pip environment
    • install python dependencies
  • Make path available

    source ~/.bashrc
    source ~/.zshrc # only if you are using zsh
  • Edit the existing tempalte.json file to update it with your own data

  • Activate environment (auto generated in previous steps)

    source venv/bin/activate # linux
  • run the command to create pdf from the data

    python3 main.py # to create pdf from template.json data of each latex template
    python3 wsgi.py # to run the flask server locally

    Note: reopen the terminal if you are not able to use the command successfully

To Running on server env (production server)

  • edit the /scripts/constants.sh file and add your custom server specifications like - domain name, etc

  • let's make it server ready

    sudo chmod +x ./scripts/oneForAll.sh && sudo ./scripts/oneForAll.sh
    • updating your system apt packages
    • install texlive (smallest version possible to run pdflatex)
    • updating pip
    • setup pip environment
    • install python dependencies
    • install nginx
    • install gunicorn
    • setup firewall (ufw) and allow ports 80 and 443
    • setup nginx configuration
    • setup gunicorn configuration
    • setup systemd service for gunicorn and nginx
    • setup ssl certificate using certbot
  • and you are all set to go πŸš€ test the server by visiting the domain name you have provided in the scripts/constants.sh file


for testing each api endpoint πŸ§ͺ

pytest -v

Open to contribution 🀝

Steps to start contributing

  1. fork the repo
  2. clone the repo
  3. create a new issue
  4. make changes
  5. push the changes
  6. create a pull request


Note: Any template name which cointains test in name will not be executed by defaultπŸ›‘οΈ


Have fun curating your resume! πŸŽ‰