Welcome to JupyterInstruct!

Written by Dirk colbry

Last updated December 2020

Link to Github Repository

These toosl as developed to help instructors maintain and share course curriculum with students using jupyter notebooks.

These tools were specificially developed to help the department of Computational Mathematics Science and Engineering at Michigan State University but should generalize as well.

NOTE: Currently under development.

To install type:

pip install git+https://github.com/colbrydi/jupyterinstruct

"""
# Welcome to JupyterInstruct!
### Written by Dirk colbry
### Last updated December 2020
### [Link to Github Repository](https://github.com/colbrydi/jupyterinstruct)

These toosl as developed to help instructors maintain and share course curriculum with students using jupyter notebooks.

These tools were specificially developed to help the department of Computational Mathematics Science and Engineering at Michigan State University but should generalize as well.


**NOTE:** Currently under development.

To install type:

```
pip install git+https://github.com/colbrydi/jupyterinstruct
``` 

"""
__version__ = '0.01dev'

Sub-modules

jupyterinstruct.InstructorNotebook

The base notebook class object. Instuctor notebooks have extra content intended only for instructors. This class manages the extra content and enables …

jupyterinstruct.console_commands

Command line tools for workign with jupyter notebooks …

jupyterinstruct.hubgrader

Interface between InstructorNotebooks and a non standard nbgrader installation. These tools help put the files in the right place so that instructors …

jupyterinstruct.nbfilename

A class designed to standardise notebook filenames. Filenames have infomration about assignments being in-class, pre-class, INSTRUCTOR versions, …

jupyterinstruct.nbvalidate

Jupyter notebook validator. These functions check for common errors in student notebooks including: …

jupyterinstruct.webtools

Tools for generating course websites from course folder.