README.md

courseutils

helper code for class

If you are trying to use this while finishing an incomplete, use the correct release.

To install from clone

git clone https://github.com/compsys-progtools/courseutils
cd courseutils
pip install .

You may need to use pip3 instead of pip. On Windows, use GitBash for the clone and then Anaconda Prompt for install

To install direct

pip install git+ https://github.com/compsys-progtools/courseutils

You may need to use pip3 instead of pip. On Windows, use GitBash for the clone and then Anaconda Prompt for install

See the docs

pip install -r requirements.txt
cd docs
make html

To upgrade:

cd courseutils
git pull
pip install .

You may need to use pip3 instead of pip On Windows, use GitBash for the clone and then Anaconda Prompt for install

Usage

This is a command line tool. It works in Bash on MacOS and Linux and Anaconda Prompt on Windows.

It will also work in a code space with

pip install git+https://github.com/compsys-progtools/courseutils