shepherd's Introduction

Shepherd

The next generation course building CI tool for A+

Architecture

Keep updating...

Get access to Shepherd from A+ using Oauth. ( Get signal from flask-lti-login and authenticate user).
model: User

Group users, grant user different privileges and permissions according to the group.
Tree-like structure. Example: Aalto → CSI → CS → Programming_1.
model:
- Group: many-to-many relationship with User.
- GroupPermission: the permission types of Group. Currently two types: (create) subgroups, (create) courses.
- CreateGroupPerm: the permission of groups for creating (sub)groups. field group is the group with the (create) subgroups permission; field target_group is the group which group can create subgroups under.
- CreateCoursePerm: the permission of groups for creating courses. the field pattern defines the prefix that the course key should follow.
- ManageCoursePerm: the permission for managing courses. The owner roles of a course include admin and assistant.

Course management interface
To create new courses, the user needs to be in a group with the (create) courses permission.
model: CourseInstance

Handle push webhook in GitHub or Gitlab.

build

Define Build tasks, define automated pipeline (pull/clone->build->deploy->clean).
repos - deploy key
- Define background task for deploy key pair generation.
- Define the scheduled task for key validation.