Skip to content
Snippets Groups Projects
Commit eca8ffc8 authored by Christopher Bohn's avatar Christopher Bohn :thinking:
Browse files

Brought README back up to date

parent c488cdac
No related branches found
No related tags found
No related merge requests found
......@@ -17,37 +17,40 @@ of repositories for student assignments.
## Files
- config.py
- provides URLs and API keys
- ignored (not present in remote repository)
- Provides URLs and API keys.
- gitignored (not present in remote repository)
- config-example.py
- sample config.py file, without API keys
- Sample config.py file, without API keys.
- *do not* commit API keys to repository
- you will need to copy to config.py and replace `None` with your API keys (as strings)
- course.py
- provides namespace and group ID
- will need to update each semester
- Provides namespace and group ID.
- You will need to update this file **each semester**
- initialize_student_tracking.py
- ...
- Creates initial student roster from responses to `03 Setup` assignment.
- prep_assignment.py
- An early iteration of automated student pairing, canvas student group creation, and gitlab repo creation. It
lacks robustness to odd number of students; it has a quick'n'dirty loop termination that does not guarantee
graylist compliance, and project naming is hard-coded. Also does not tolerate non-existent usernames.
- Automates student pairing, creating student groups in Canvas, and creating team repositories in GitLab. There
are a few areas where it could be more robust, but it will handle non-capstone assignments (it currently only
creates pairs, or triples when it must), creating partners without regard to course section, and it will do so
without crashing.
- grade_team_contributions.py
- ...
- Retrieves peer reviews from Canvas and commit histories from GitLab. Use this data to make informed teamwork
grading decisions, but bear in mind you might have to dig deeper. Does not (yet) place grades in Canvas
gradebook.
- **Recommendation**: pipe output to `tee` to maintain a copy of the data.
- Timeline.py
- ...
- timeline_data.py
- ...
- Timeline.py & timeline_data.py
- These are part of an attempt to track git usage over the course of a project to create burndown charts and to
observe which branch is each commit's original branch. Unless we upgrade to GitLab Pro, I'll probably get back
to this effort (but it's not a high priority).
- common_functions.py
- ...
- Contains exactly what the file's name says it contains: utility functions that are used by more than one script.
- api/
- canvas_classes.py
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment