foss-profiles's Introduction

foss-profiles

HTML page generator for FOSS@MAGIC student, faculty, and alum profiles from YAML files

About

foss-profiles helps FOSS@MAGIC faculty and staff maintain a current roster of:

Alums
Faculty
Mentors
Students

The profiles are used for record-keeping and contact information. They are also planned to eventually appear on the reworked FOSS@MAGIC website.

Installation

foss-profiles uses pipenv to manage dependencies. Read their docs for installation help.

Once pipenv is installed, run these commands to initialize your development environment:

pipenv sync --dev
pipenv shell

Usage

usage: generate_profiles.py [-h] [--template TEMPLATE]
                            [--roles ROLES [ROLES ...]] [--output OUTPUT]
                            directory

positional arguments:
  directory             Directory to read through

optional arguments:
  -h, --help            show this help message and exit
  --template TEMPLATE, -t TEMPLATE
                        Jinja template to use
  --roles ROLES [ROLES ...], -r ROLES [ROLES ...]
                        Ordered list of roles to use
  --output OUTPUT, -o OUTPUT
                        Output filename

Contributing

Want to contribute a profile? See our contributing guidelines.

If you want to help with the actual project, awesome! Help is welcome to make the template prettier or anything you think could be improved. Note foss-profiles is a Python 3.6 project.

Need help? Join #rit-foss on the Freenode IRC network or join the bridged Telegram group.