https://github.com/charlesfrye/otter-demo

a demonstration of an otter-grader workflow
https://github.com/charlesfrye/otter-demo

Last synced: about 1 month ago
JSON representation

a demonstration of an otter-grader workflow

• Host: GitHub
• URL: https://github.com/charlesfrye/otter-demo
• Owner: charlesfrye
• Created: 2022-03-04T21:36:12.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-03-05T00:59:38.000Z (almost 3 years ago)
• Last Synced: 2024-10-27T15:37:31.462Z (3 months ago)
• Language: Jupyter Notebook
• Size: 4.88 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# otter-demo

Demonstration of an

[`otter-grader`](https://otter-grader.readthedocs.io/en/latest/index.html)

workflow.

1. Edit autograded notebook, here `lab.ipynb`, and any associated files, here `foo.py`.

2. Get the notebook into canonical state, e.g. with "Restart & Run All".

3. Run `otter assign lab.ipynb ./dist --v1`. If any tests fail, the workflow fails.

4. Make any additional adjustments to associated files, e.g. hiding code in `.py` files.

5. Copy files to student repo (here, using `bundle.sh`), including `tests/`

6. Commit-and-push changes to both repos.

Once automated, this can all easily be wrapped into a makefile.

TODOs

1. Automate notebook normalization.

2. Automate adjustments to associated code.

3. Make `bundle.sh`

4. Consider pros and cons of git automation, e.g. with GH actions.

Example output is in [this repo](https://github.com/charlesfrye/otter-demo-labs).