urnc 1.2.4

A package to convert UR FIDS jupyter notebooks

URNC

UR FIDS notebook converter

Installation

pip install urnc

Or update from an older version

pip install urnc --upgrade

Usage for a course

This assumes your working directory is somewhere in a course directory

    cd my_urnc_course

Check the current course version

    urnc version 

Edit the course files.

Check for errors only:

    urnc check . 

See how the course will look for a student by converting your notebook files

    urnc convert . ./student

This will create a copy of all notebook files in the folder student and convert them to the student version. You can check the output with jupyter. e.g

    cd student
    jupyter-lab

Once you are happy with your changes commit them. Make sure to delete the student folder again or add it to .gitignore. In the clean repo use urnc to create a version commit.

    urnc version patch
    git push --follow-tags

The --follow-tags option is only required if git does not push tags by default. We recommend configuring git to push tags automatically

    git config --global push.followTags true

The version is a semver. You can also run

    urnc version minor 
    urnc version major 

This will trigger the ci pipeline of the repo and create a student branch.

Contribution

First check that you have the lateste version of this repo

    git pull
    urnc version --self

If you want to make changes to urnc update the python files in urnc and commit the changes. Afterwards use

    urnc version --self patch
    # or urnc version --self minor 
    # or urnc version --self major 
    git push --follow-tags

To create a tagged commit and trigger the Githup actions.

The --follow-tags option is only required if git does not push tags by default. We recommend configuring git to push tags automatically

    git config --global push.followTags true