nbgrader Integration with JupyterHub and Kubernetes

Kevin Rong | Abigail Almanza | Lawrence Lee | Eric Li

Team KALE

Project Introduction Video

Youtube Video Demo

Table of Contents

User Documentation

• Preface
  • Intended Audience
  • Text Conventions
  • Acknowledgments
  • Related Documentation
• Project Overview
  • Background
  • Goals
  • Features
  • Future Application
• Installing
  • Installing on a Z2JH Cluster
    • Installing ngshare
    • Installing ngshare_exchange
  • Intalling in a Regular JupyterHub Environment as a Managed Service
    • Installing ngshare
    • Installing ngshare_exchange
  • Intalling as an Unmanaged Service
    • Installing ngshare
    • Installing ngshare_exchange
• Uninstalling
  • Uninstalling ngshare
  • Uninstalling ngshare_exchange
• Upgrading
  • Upgrading ngshare
  • Upgrading ngshare_exchange
• Command Line Arguments
  • Regular Arguments
    • --database PATH_TO_DATABASE
    • --storage PATH_TO_STORAGE
    • --admins ADMIN1,ADMIN2,ADMIN3
  • Advanced Arguments
    • --debug
    • --no-upgrade-db
    • --jupyterhub_api_url CUSTOM_API_URL
    • --prefix PREFIX
    • --vngshare
    • --host BIND_HOST and --port BIND_PORT
• Extra Features
  • Welcome Page
  • Debug Actions
    • Dump Database
    • Clear Database
    • Initialize with Test Data
  • Health Endpoint
  • vngshare
• Notes for Administrators
  • Admin Users
  • User Name Reuse
  • Race Condition
  • Storage
  • Database Upgrade
  • Database Backup
  • Removing Semantics
  • Internal Server Error
  • Limitations
• Notes for Instructors
  • Course Creation
  • Managing Students
  • Configuring nbgrader
  • Using Formgrader
• Course Management
  • Admin Only Commands
    • Creating Courses
    • Adding/Updating Instructors
    • Removing Instructors
  • Instructor Commands
    • Adding a Single Student
    • Adding Students in Bulk
    • Removing Students
• Demo
  • Creating Course
  • Adding Students
  • Releasing Assignment
  • Doing Assignment
  • Grading Assignment
  • Viewing Feedback
• Reporting Bugs
• Frequently Asked Questions
  • Do I need to backup database?
  • Will attackers be able to clear ngshare database?
• Change Log
  • 0.5.1
  • 0.5.0

APIs

• APIs Introduction
• Definitions
  • Admin User
  • Assignment Name
  • Checksum
  • Course Name
  • Directory Tree
  • Instructor ID
  • Notebook Name
  • Student ID
  • Timestamp
• Request and Response Format
  • Requests
  • Response
• Authentication
  • ngshare Authentication
  • vngshare Authentication
• Course APIs
  • /api/courses: Courses
  • /api/course: Course
  • /api/instructor: Course Instructor Management
  • /api/instructors: List Course Instructors
  • /api/student: Student Management
  • /api/students: List Course Students
• Assignment APIs
  • /api/assignments: Course Assignments
  • /api/assignment: Fetching and Releasing an Assignment
  • /api/submissions: Listing Submissions
  • /api/submission: Collecting and Submitting a Submission
  • /api/feedback: Fetching and Releasing Submission Feedback

Contributor Guide

• Project Structure
  • ngshare
  • Version Number
  • Continuous Integration
  • Documentation
  • Deployment
  • Testing
  • ngshare_exchange
• Decisions
  • Technologies Employed
  • Race Condition
  • Database Update
• Developer Installation
  • Install from GitHub
  • Run Installed ngshare
  • Run ngshare without Installation
  • Run vngshare
• vngshare
  • Install
  • Default Behavior
  • Development History
  • Historical Project Structure
• Development
  • Stand-Alone Mode
  • Unit Testing
  • Code Formatting
  • Contributing
• Database Structure
  • Tables
  • Allocation Tables
  • Assignment State
  • Entity Relationship Diagram
• Migration with Alembic
  • Upgrade Database
  • Create New Version
  • Reference
  • Update History
• Documentation
  • Documentation Formatting
• Deployment

Appendix

• Glossary
• Contact Information
  • Team Members
  • Clients
  • Jupyter Community
  • Deployment
• Technology Survey
  • The Problem
  • Alternative Solutions
  • ngshare
• Requirements
  • User Stories
• Prototyping code
• Technologies Employed
  • Backend
  • Database
  • Progamming Language
  • Project Management
• System Architecture Overview
• Legal & Social Aspects
• Porting nbextensions to JupyterLab
  • Assignment List
  • Create Assignment
  • Course List
  • Formgrader
  • Validate Assignment