Setup nbgrader in one class, one grader mode

TEACH.md

@@ -0,0 +1,29 @@
+# Teaching with eWaterCycle infra
+
+The grading setup is [one class, one grader](https://nbgrader.readthedocs.io/en/stable/configuration/jupyterhub_config.html#example-use-case-one-class-one-grader).
+
+## Surf Research Cloud configuration
+
+In the SRC component
+
+- Add `grader_user` parameter with username of person who will be grading.
+  This user will also be responsible for setting up the course and assignments.
+
+## Students
+
+Students can be managed with [nbgrader labextension & cli](https://nbgrader.readthedocs.io/en/stable/user_guide/managing_the_database.html#managing-students)
+
+The student id is a posix username in the VM.
+In a ewatercycle VM users can be created with `sudo adduser` or with [Surf Research Access Management](https://sram.surf.nl/). After invite a cronjob will add the user to the VM. Login with totp as password.
+
+## Create assignment
+
+1. In menu goto Nbgrader -> Formgrader -> Manage Assignments -> Add new Assignment.
+2. Click on edit to navigate to folder (`~/hydrolog101/source/<name of assignment>`).
+3. Create a notebook with assignment annotations using the `Create Assignment` sidebar.
+4. In FormGrader press Generate, Preview, Release buttons.
+
+## Fetch assignment
+
+1. In menu got Nbgrader -> Assignments
+2. Press fetch button

research-cloud-plugin.yml

@@ -99,6 +99,10 @@
       include_role:
         name: jupyter
 
+    - name: Set up grader
+      include_role:
+        name: grader
+
     - name: Clean apt cache
       apt:
         autoclean: true

roles/ewatercycle/templates/environment.yml.j2

@@ -21,6 +21,7 @@ dependencies:
       # TODO Once available uncomment the following line
       # - git+https://github.com/eWaterCycle/ewatercycle-sfincs
       - era5cli
+      - e2xgrader
   - setuptools
   - altair_saver
   - altair
@@ -77,3 +78,4 @@ dependencies:
   - nbdime
   - nbgitpuller
   - papermill
+  - nbgrader

roles/grader/README.md

@@ -0,0 +1,38 @@
+Role Name
+=========
+
+A brief description of the role goes here.
+
+Requirements
+------------
+
+Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
+
+Role Variables
+--------------
+
+A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
+
+Dependencies
+------------
+
+A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
+
+Example Playbook
+----------------
+
+Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
+
+    - hosts: servers
+      roles:
+         - { role: username.rolename, x: 42 }
+
+License
+-------
+
+BSD
+
+Author Information
+------------------
+
+An optional section for the role authors to include contact information, or a website (HTML is not allowed).

roles/grader/defaults/main.yml

@@ -0,0 +1,5 @@
+---
+# defaults file for grader
+exchange_root: /var/local/nbgrader/exchange
+grader_user: vagrant
+course_id: hydrolog101

roles/grader/handlers/main.yml

@@ -0,0 +1,2 @@
+---
+# handlers file for grader

roles/grader/meta/main.yml

@@ -0,0 +1,52 @@
+galaxy_info:
+  author: your name
+  description: your role description
+  company: your company (optional)
+
+  # If the issue tracker for your role is not on github, uncomment the
+  # next line and provide a value
+  # issue_tracker_url: http://example.com/issue/tracker
+
+  # Choose a valid license ID from https://spdx.org - some suggested licenses:
+  # - BSD-3-Clause (default)
+  # - MIT
+  # - GPL-2.0-or-later
+  # - GPL-3.0-only
+  # - Apache-2.0
+  # - CC-BY-4.0
+  license: license (GPL-2.0-or-later, MIT, etc)
+
+  min_ansible_version: 2.1
+
+  # If this a Container Enabled role, provide the minimum Ansible Container version.
+  # min_ansible_container_version:
+
+  #
+  # Provide a list of supported platforms, and for each platform a list of versions.
+  # If you don't wish to enumerate all versions for a particular platform, use 'all'.
+  # To view available platforms and versions (or releases), visit:
+  # https://galaxy.ansible.com/api/v1/platforms/
+  #
+  # platforms:
+  # - name: Fedora
+  #   versions:
+  #   - all
+  #   - 25
+  # - name: SomePlatform
+  #   versions:
+  #   - all
+  #   - 1.0
+  #   - 7
+  #   - 99.99
+
+  galaxy_tags: []
+    # List tags for your role here, one per line. A tag is a keyword that describes
+    # and categorizes the role. Users find roles by searching for tags. Be sure to
+    # remove the '[]' above, if you add tags to this list.
+    #
+    # NOTE: A tag is limited to a single word comprised of alphanumeric characters.
+    #       Maximum 20 tags per role.
+
+dependencies: []
+  # List your role dependencies here, one per line. Be sure to remove the '[]' above,
+  # if you add dependencies to this list.

roles/grader/tasks/main.yml

@@ -0,0 +1,40 @@
+---
+# tasks file for grader
+- name: Exchange directory
+  file:
+    path: '{{ exchange_root }}'
+    state: directory
+    mode: '0777'   
+- name: /etc/jupyter
+  file:
+    path: /etc/jupyter
+    state: directory
+    mode: '0755'
+- name: Global nbgrader config
+  copy:
+    dest: /etc/jupyter/nbgrader_config.py
+    mode: 0644
+    content: |
+      c = get_config()
+      c.Exchange.root = '{{ exchange_root }}'
+- name: Grader jupyter dir
+  file:
+    path: /home/{{ grader_user }}/.jupyter
+    state: directory
+    owner: '{{ grader_user }}'
+    mode: '0755'
+- name: nbgrader config for grader user
+  copy:
+    dest: /home/{{ grader_user }}/.jupyter/nbgrader_config.py
+    mode: 0644
+    owner: '{{ grader_user }}'
+    content: |
+      c = get_config()
+      c.CourseDirectory.course_id = '{{ course_id }}'
+      c.CourseDirectory.root = '/home/{{ grader_user }}/{{ course_id }}'
+- name: Course directory
+  file:
+    path: '/home/{{ grader_user }}/{{ course_id }}'
+    state: directory
+    owner: '{{ grader_user }}'
+    mode: '0755'

roles/grader/tests/inventory

@@ -0,0 +1,2 @@
+localhost
+

roles/grader/tests/test.yml

@@ -0,0 +1,5 @@
+---
+- hosts: localhost
+  remote_user: root
+  roles:
+    - grader

roles/grader/vars/main.yml

@@ -0,0 +1,2 @@
+---
+# vars file for grader