https://github.com/rahji/gradescale
A command-line tool for generating a letter grade scale based on total number of points for the semester
https://github.com/rahji/gradescale
charmbracelet cli golang grades teaching-tools
Last synced: 2 months ago
JSON representation
A command-line tool for generating a letter grade scale based on total number of points for the semester
- Host: GitHub
- URL: https://github.com/rahji/gradescale
- Owner: rahji
- License: mit
- Created: 2024-07-31T18:39:05.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-08-16T04:09:53.000Z (10 months ago)
- Last Synced: 2025-02-06T02:51:23.605Z (4 months ago)
- Topics: charmbracelet, cli, golang, grades, teaching-tools
- Language: Go
- Homepage:
- Size: 1.23 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gradescale
Note: Maybe use [syllabuster](https://github.com/rahji/syllabuster) instead :)
I don't like grading based on percentages. It's easier for me to come up
with an integer number of points for each assignment/task and sum them to arrive
at a total number of available points for the semester.
This program accepts that total number of points (an integer) and generates a markdown table
that shows how they equate to letter grades. It uses a config file that defines the reference scale.
While the reference scale may use fractional numbers, the new scale is in whole numbers.
The output of `gradescale` looks great when piped to [glow](https://github.com/charmbracelet/glow).
Otherwise, you can just copy/paste it into your syllabus. (Everyone uses markdown for their syllabi, right?)
## Installation
The easiest way to install is to download the appropriate archive file from the [Releases](https://github.com/rahji/gradescale/releases/latest) page, place the `gradescale` binary [somewhere in your path](https://zwbetz.com/how-to-add-a-binary-to-your-path-on-macos-linux-windows/), and run it from your terminal (eg: Terminal.app in MacOS or [Windows Terminal](https://apps.microsoft.com/store/detail/windows-terminal/9N0DX20HK701?hl=en-us&gl=us&rtc=1))
**OR** If you have `go` installed you can clone this repo and run `make build`
You might want to install [glow](https://github.com/charmbracelet/glow), too.
## Usage
```
gradescale creates a letter grade scale based on a max number of points.
The new scale is proportional to an existing reference scale.
The original scale can include fractional numbers.
The new scale uses whole numbers.
Usage:
gradescale [flags]
Flags:
--config string config file (default is ./gradescale.yaml)
--debug output debug info instead of the grade scale
-h, --help help for gradescale
--points float the total number of points in the new scale (required)
```
## Screen Capture
## Credits
Image by