/FOSSProfiles

HTML generator to create a page for student profiles from YAML files

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

StudentProfiles Build Status

HTML generator to create a page for FOSS@MAGIC profiles from YAML files

About

StudentProfiles helps FOSS@MAGIC faculty and staff maintain a current roster of:

  • Alums
  • Faculty
  • Mentors
  • Students
  • Student captains

The profiles are used for record-keeping or for other purposes, like alum or student profiles on the FOSS@MAGIC website.

Requirements

To generate profiles, you need the following packages.

  • python3
  • python3-jinja2
  • python3-PyYAML

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

If you want to contribute a profile, see our contributing guidelines.

If you want to help with the actual project, awesome! We'd love any help to make the template prettier or anything that you think should be changed. Python 3.6 is recommended for your development environment, along with using Python virtual environments.

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

Legal

All work in this repo is licensed under the GPLv3 license.