mark-calculator

A simple cli tool designed to help calculate the required marks for each of your university modules to reach a target overall grade. It takes into account the credit weighting of each module & completed tests that account for a % of the module grade, allowing you to easily determine what grade you need in each module to achieve your target grade.

Usage

You can easily start the app using docker, like so

docker run --rm -v mark-calculator:/app/data mark-calculator

I would recommend using an alias so that you do not need to run the entire command each time, to do this add the following to either ~/.bashrc or ~/.zshrc depending on your shell.

alias mark-calculator="docker run --rm -v mark-calculator:/app/data mark-calculator"

All examples documented below use this alias.

If you have python installed, you can also just run

python3 main.py

from within the root directory.

First, you will need to add your modules - add all modules, including ungraded ones.

The --grades flag and the --weights flag are the corresponding test scores as well as the weighting they are to the overall module, so for example, if you have a module with two tests - which are equally weighted - with scores of 65 and 70 you would do the following:

mark-calculator add --name="My module" --credits=20 --grades=65,70 --weights=0.5,0.5

If your module has not received a grade, do not add the --grades flag - likewise if you have uncompleted tests do not add them. To consider the remaining uncompleted test scores, make sure to add the accurate weight for the uncompleted grades.

If you want to remove a module after adding one, run the following

mark-calculator remove --name="My module"

Once all modules have been added, you can run the file with no command prefix, like so

mark-calculator --target=70

where --target is the overall target grade you wish to achieve for the entire year.

If you want to review grades on added modules and also review your overall current grade, you can use the following command

mark-calculator list

For all commands and flags, run --help

Install

If you have python installed, you do not need to install anything, just ensure you are using python 3.13.x otherwise there may be unintended side effects.

To easily get started without python, you can use docker. Firstly, you need to build the image by running the following command in the root directory:

docker build -t mark-calculator .

Once completed, you can simply get started.

Todo

• Add a "confidence" score for each module, so you can apply weighting to each one based on how well you think you can do