resume - GitLite

KO | EN

gitlite — search

#javascript #python #react #ai #typescript #golang #go #rust #linux #nodejs #macos #awesome #pytorch #ios

resume

(★ 108)

Python resume generator. From YAML to PDF and static HTML.

File Explorer

Download Latest Version (.zip)

- hanula.yaml
- jmbeach.yaml
- - 404.jinja2
  - apple-touch-icon-precomposed.png
  - crossdomain.xml
  - favicon.ico
  - humans.txt
  - index.jinja2
  - robots.txt
- - 404.jinja2
  - apple-touch-icon-precomposed.png
  - crossdomain.xml
  - favicon.ico
  - humans.txt
  - index.jinja2
  - robots.txt
.gitignore
build.py
config.make.example
CONTRIBUTORS
helpers.py
LICENSE
Makefile
README.md
requirements.txt

# Installation Guide

1. Get the code

git clone https://github.com/hanula/resume

Downloads the entire project code from GitHub to your computer.

cd resume

Moves into the project folder you just downloaded.

2. Python

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

pip install -r requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

✅ If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

3. Make

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).

make pdf

Compiles the code based on the generated build configuration to produce an executable.

make publish

Compiles the code based on the generated build configuration to produce an executable.

✅ If it finishes without errors, it worked. Try running the generated executable directly.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

resume
======

Python resume generator. From YAML to PDF and static HTML.

Example Themes
--------------
* [simple](http://resume.hanula.com/)
* [compact](http://jmbeach.github.io/resume/)

Installing
----------

git clone https://github.com/hanula/resume
    cd resume
    pip install -r requirements.txt

### Requirements

This script requires `Python 3` and a set of libraries with their dependencies:

PyYAML
    Jinja2
    Markdown
    WeasyPrint
    docopt

Usage
-----

1. Look at resume examples in the `resumes` folder and create your own.
2. Copy `config.make.example` to `config.make` and update it with your settings.
3. Run `make` to build HTML and PDF files that will go to the `build` directory.

### PDF generator

PDF is automatically generated along with html when running `make`.
To just create PDF file:

make pdf

PDF file name in `build` directory is defined by `pdf_file` property in the `config` section of your resume `yaml` file.

### Publishing

To publish html on your server via SSH, edit `RSYNC_LOCATION` in `config.make` and run:

make publish

Customizing
-----------
This repo contains a simple and a compact theme.

Add your own theme by creating `themes/<your-theme>` folder with `index.jinja2` template file.
Every other (non-jinja2) file from theme directory will be copied to final `build/` destination.

You can control which theme is used by setting `theme` property in the resume's `config` section.

License
-------
[MIT License](https://github.com/hanula/resume/blob/master/LICENSE)