https://github.com/itzalak/pyresume

My python approach to building my resume from markdown
https://github.com/itzalak/pyresume

markdown resume

Last synced: about 1 month ago
JSON representation

My python approach to building my resume from markdown

• Host: GitHub
• URL: https://github.com/itzalak/pyresume
• Owner: itzalak
• License: mit
• Created: 2022-01-22T11:27:37.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-16T20:30:03.000Z (8 months ago)
• Last Synced: 2024-04-18T17:11:32.189Z (8 months ago)
• Topics: markdown, resume
• Language: Python
• Homepage:
• Size: 22.5 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Pyresume

This is a python script to build a pdf resume based on a markdown file and some given css style.

This package is just for documentation purposes and generating my own resume, if you found yourself here, you are probably

lost...

## Credits

This code is just a wrapper for the work done by Julien Maupetit with [md2pdf](https://github.com/jmaupetit/md2pdf).

## Requirements

- Python

- Black

- Poetry

- Pre-commit

- Commitizen

- Weasyprint

## Instructions

Instructions for setup can be found in the [makefile](./makefile)

## Examples

To generate a resume:

1. Place your resume file in `./pyresume/assets/resume.md`

2. Select a style from [style folder](./pyresume/assets/styles/) if none is selected defaults to [simple style](pyresume/assets/styles/simple-style.css)

3. Run the execution command from the examples below, like `make resume-simple`, or `poetry run python pyresume/__main__.py -bar`

4. Find the pdf resume under [output folder](./output)

- Create a resume with simple look using makefile

```shell

make resume-simple

```

- Or use poetry, available style options are `-simple`, `-bar`, `-divider`

```shell

poetry run python pyresume/__main__.py -simple

```

- Run with path to your own css style

```shell

poetry run pyresume/__main__.py --style {{path/to/user/style.css}}

```

### Tests

- Run all tests

```shell

poetry run pytest

```