lucydot / choochoo Goto Github PK

• Perhaps by using an empty Jekyll theme (which will still allow for access to useful environment variables like the repo web address): https://stackoverflow.com/questions/57419996/jekyll-without-a-theme

Hello Student 👋

Welcome to Choochoo the checklist tool! 🚋

Your personal checklist is generated below. You can also interact with me, choochoo-bot, using commands in this thread.
To list all possible choochoo commands type choochoo list commands in comment box below.

Hello Student 👋

Welcome to Choochoo the checklist tool! 🚋

Your personal checklist is generated below. You can also interact with me, choochoo-bot, using commands in this thread.
To list all possible choochoo commands type choochoo list commands in comment box below.

Hello Instructor 👋

Welcome to Choochoo the checklist tool! 🚋

Here are some commands you might like use in this thread:

• Add students to this repo: choochoo add @username as student
• Add instructors to this repo: choochoo add @username as instructor
• Monitor class progress: choochoo monitor class progress
• List all possible choochoo commands: choochoo list commands

TODO

Core

• linting!
• Restrict python versions as relying on dict type being ordered
• Rename choochoo student thread to choochoo checklist thread
• How to handle testing?
• #37
• Many:many mapping between objectives and questions using yaml + python dictionaries (mysql prob overkill)
• Separate out the choochoo repo from the choochoo-template project repo
• Automatically compile anything committed to main in questions/, tutorials/ or plots/ into html and publish on gh-pages
• Stop students from creating more than one checklist per person
• #38
• Allow admins to enable or disable the github pages branch
• #39
• Allow admins to enable or disable the student questions
• #43
• Encourage all contributors specification
• Only allow generate questions command in question thread
• print markdown lists (authors, objectives) with commas
• Google style docstrings and generate API documentation using https://mkapi.daizutabi.net/
• Change question_proposal and accepted_question. to question and then either accepted or proposed.
• Better testing of different gh_branch in settings - need to put into. workflow files for example?
• Rename "instructor" issue as "management" issue?
• When parsing choochoo commands strip whitespace
• Allow instructors/admins to generate question sets with a particular filename
• Add links to the question sets from the course webpage
• Update list commands output
• Change settings so that has owner and repo_name and auto build the website address, then can move to advanced.
• Add generated command and time to question sets (and plots)
• Make choochoo commands more robust: for example, allow trailing spaces.

Bugs

• choochoo check @X is instructor does not work

Improvements

• Improve integration setup - use submodule?
• Add question to multiple objectives
• Reduce the number of workflows triggered by not triggering deploy plots and deploy questions everytime choochoo is ran...
• call choochoo build question bank as part of choochoo bank question?
• Change all emojis to openmojis with attribution
• I think the two functions check_student and check_question in the fat controller workflow can be combined
• Re-structure objectives module so that the methods to create dictionaries are class methods (as in Question class)
• Document the commands in a table with columns: where can they be run, who can run them.
• rename add_student
• message if someone tries to generate more questions than are available
• have option to replace icon on the summary page
• change y-axis of summary plot to the objective number, then give objective when hovering over the bar
• #44
• Don't allow instructors, admins etc to be added twice
• Command to summarise proposed questions, question votes and accepted questions
• Error handling, especially in env.py
• Add timestamp to the summary plot(s)
• #41
• #42
• Choochoo returns update messages to issue thread when command is executed
• Assign the issues to appropriate people (the people who raised them?)
• Enforce the vote-once rule for a proposed question (currently requires manual check before acceptance)
• Class hierachy diagram for easy visualisation
• Add links to author names in question bank (markdown) and on the issue thread
• #40
• when writing to settings.yml keep the same formatting as in original
• Add a choochoo list objectives command
• check link, question, tutorial new before adding them to an objective
• create function for long repeated code in add link (.+) to objective ([1-9]+) et al.
• all-contributors type system to recognise student contributions to the question bank?

Hello Instructor 👋

Welcome to Choochoo the checklist tool! 🚋

Here are some commands you might like use in this thread:

• Add students to this repo: choochoo add @username as student
• Add instructors to this repo: choochoo add @username as instructor
• Monitor class progress: choochoo monitor class progress
• List all possible choochoo commands: choochoo list commands

See - https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-template-repository. Should get around problem of not being able to clone multiple repos for different classes..

Hello Student 👋

Welcome to Choochoo the checklist tool! 🚋

Your personal checklist is generated below. You can also interact with me, choochoo-bot, using commands in this thread.
To list all possible choochoo commands type choochoo list commands in comment box below.

For example, all keys in objectives.yml must be given, with values set at [] if unused.

Should be do-able by capturing the exceptions (e.g. keyerror or NoneType error) when raised.

Hello Instructor 👋

Welcome to Choochoo the checklist tool! 🚋

Here are some commands you might like use in this thread:

• Add students to this repo: choochoo add @username as student
• Add instructors to this repo: choochoo add @username as instructor
• Monitor class progress: choochoo monitor class progress
• List all possible choochoo commands: choochoo list commands

For example, the traceback error here (https://github.com/lucydot/ChooChoo-template/runs/6109797183?check_suite_focus=true) could be posted to the thread so "silly" errors can be caught more easily.

How to grant access to Choochoo bot?

• I add the choochoo bot personal access token to a repository (https://vaibhavsagar.com/blog/2020/05/04/github-secrets-api/) - seems like this can only be done via API, eugh.
• users create their own Choochoo bot: https://roadie.io/docs/integrations/github-token/- turn Choochoo into a github app: https://github-app-tutorial.readthedocs.io/en/latest/index.html
• turn Choochoo into a github app: https://github-app-tutorial.readthedocs.io/en/latest/index.html

For example, the issue.Issue class can be choochoo-student type or choochoo-teacher type and each one has allowed and disallowed methods. Probably need to make better use of inheritence to control this.

Hello Instructor 👋

Welcome to Choochoo the checklist tool! 🚋

Here are some commands you might like use in this thread:

• Add students to this repo: choochoo add @username as student
• Add instructors to this repo: choochoo add @username as instructor
• Monitor class progress: choochoo monitor class progress
• List all possible choochoo commands: choochoo list commands

• Think about how choochoo will integrate into an existing course repo rather than being in a standalone repo
• Integration may lead to less functionality - for example, may not have an associated gh_pages branch.
• Ask people to install in project as subfolder (but not git submodule
• https://stackoverflow.com/questions/11497457/git-clone-without-git-directory).- give option to install with or without github pages branch?

Hello Instructor 👋

Welcome to Choochoo the checklist tool! 🚋

Here are some commands you might like use in this thread:

• Add students to this repo: choochoo add @username as student
• Add instructors to this repo: choochoo add @username as instructor
• Monitor class progress: choochoo monitor class progress
• List all possible choochoo commands: choochoo list commands

Hello Instructor 👋

Welcome to Choochoo the checklist tool! 🚋

Here are some commands you might like use in this thread:

• Add students to this repo: choochoo add @username as student
• Add instructors to this repo: choochoo add @username as instructor
• Monitor class progress: choochoo monitor class progress
• List all possible choochoo commands: choochoo list commands

Hello Instructor 👋

Welcome to Choochoo the checklist tool! 🚋

Here are some commands you might like use in this thread:

• Add students to this repo: choochoo add @username as student
• Add instructors to this repo: choochoo add @username as instructor
• Monitor class progress: choochoo monitor class progress
• List all possible choochoo commands: choochoo list commands

Allow multiple users to be added as students, instructors etc: so instead of finding handles by positions, search by words starting with @ and then form this into a list of strings. Regex will do this task quite nicely!

Hello Instructor 👋

Welcome to Choochoo the checklist tool! 🚋

Here are some commands you might like use in this thread:

• Add students to this repo: choochoo add @username as student
• Add instructors to this repo: choochoo add @username as instructor
• Monitor class progress: choochoo monitor class progress
• List all possible choochoo commands: choochoo list commands

Hello Student 👋

Welcome to Choochoo the checklist tool! 🚋

Your personal checklist is generated below. You can also interact with me, choochoo-bot, using commands in this thread.
To list all possible choochoo commands type choochoo list commands in comment box below.

Hello Instructor 👋

Welcome to Choochoo the checklist tool! 🚋

Here are some commands you might like use in this thread:

• Add students to this repo: choochoo add @username as student
• Add instructors to this repo: choochoo add @username as instructor
• Monitor class progress: choochoo monitor class progress
• List all possible choochoo commands: choochoo list commands

Hello Instructor 👋

Welcome to Choochoo the checklist tool! 🚋

Here are some commands you might like use in this thread:

• Add students to this repo: choochoo add @username as student
• Add instructors to this repo: choochoo add @username as instructor
• Monitor class progress: choochoo monitor class progress
• List all possible choochoo commands: choochoo list commands

Hello Instructor 👋

Welcome to Choochoo the checklist tool! 🚋

Here are some commands you might like use in this thread:

• Add students to this repo: choochoo add @username as student
• Add instructors to this repo: choochoo add @username as instructor
• Monitor class progress: choochoo monitor class progress
• List all possible choochoo commands: choochoo list commands

Hello Instructor 👋

Welcome to Choochoo the checklist tool! 🚋

Here are some commands you might like use in this thread:

• Add students to this repo: choochoo add @username as student
• Add instructors to this repo: choochoo add @username as instructor
• Monitor class progress: choochoo monitor class progress
• List all possible choochoo commands: choochoo list commands

The CLI is clunky: perhaps use switch instead (Python 3.9+ only). Or create my own simple parser (command class).