urnc 1.4.0

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

All following commands assume your working directory is somewhere inside 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 latest version of this repo:

git pull
urnc version --self

If you want to make changes to urnc update the python files in urnc and test your changes as described in section Testing. When you are happy with your changes, push them to Github. Afterwards use the following commands to create a tagged commit and trigger the Github actions:

urnc version --self patch
# or urnc version --self minor
# or urnc version --self major
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

Testing

The easiest way to test urnc updates on real data is to:

1. Clone urnc
2. Clone your course of interest, e.g. urnc-example-course
3. Add the folder you cloned urnc into to your PYTHONPATH
4. Call urnc as usual

The corresponding commands are something like:

# Clone urnc and urnc-example-course
git clone https://github.com/spang-lab/urnc.git
git clone https://github.com/spang-lab/urnc-example-course.git

# Add urnc to your pythonpath
export "PYTHONPATH=$(pwd)/urnc" # bash/zsh syntax
$env:PYTHONPATH = "$(pwd)\urnc" # powershell syntax

# Make some updates to ./urnc/urnc/*.py

# Call urnc as usual
pushd urnc-example-course
urnc student
popd