Build and maintain courses using Jupyter Notebooks.
Project description
kōsu / コース
kosu
is a command-line utility to help you build and maintain courses using Jupyter Notebooks.
Installation
To install kosu:
pip install kosu
Or if you want to upload to S3 later, use the aws
option like so:
pip install kosu[aws]
See the documentation for more information.
Getting started
To set up a new collection of courses:
mkdir mycourses
cd mycourses
kosu init
This will create several directories and files in the directory mycourses
. You can run some of the other commands in this guide to see how they work.
The content of the course is controlled by example-course.yaml
. Note that only title
and curriculum
are required fields. There is also a global control file, .kosu.yaml
, which contains some parameters you will want to set and maintain.
To build the example course:
kosu build example-course
This will create a ZIP file of the course content.
To add more courses using the same pool of content, add another YAML control file.
Documentation
Read the documentation for more on using the tool, as well as for information about contributing to kosu
, the licence, etc.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.