studentresume

Installation

Please first create a venv:

For windows users:

python -m venv [VENV_NAME]

to activate:

.\venv\scripts\activate

---

for linux/mac users

virtualenv venv --python=python3

to activate:

source venv/bin/activate

Usage

To generate a resume

studentresume [OPTIONS] [RESUME_JSON] [THEME_JSON]

For a detailed help message and optional flags, please use:

studentresume --help

Additional info for contributors

Clone the repo:

git clone git@github.com:open-uofa/studentresume.git

Navigate to the repo:

cd studentresume

Install the package using Poetry (preferred):

poetry install

If authenticated to publish to pypi

poetry publish --build

---

provided files:

sample.resume.json - a sample resume.json

schema.json - the schema for resume.json files

theme-schema.json - the schema for theme.json files

../themes/* - location of default theme files

requiredFields.json - required fields if required is true then field must exist with the listed fields being filled if required false if the field is present then the listed fields must be filled

---

studentresume stands on the backs of giants ReportLab, Typer, rich, JSON Resume, and NerdFonts

License

This project is licenced under the terms of the MIT license