quickgrade 0.1.1__py3-none-any.whl

quickGrade/cli.py

@@ -0,0 +1,75 @@
+import argparse
+
+from quickGrade.grades import (
+    letter_to_gpa,
+    letter_to_percent,
+    gpa_to_letter,
+    gpa_to_percent,
+    percent_to_gpa,
+    percent_to_letter,
+)
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        description="A tool to convert between letter grades, percentages, and GPAs"
+    )
+
+    input_group = parser.add_mutually_exclusive_group(required=True)
+
+    input_group.add_argument(
+        "--letter", type=str, help="The student grade as a letter grade"
+    )
+    input_group.add_argument(
+        "--percent", type=int, help="The student grade as a percentage"
+    )
+    input_group.add_argument(
+        "--gpa", type=float, help="The student grade as a Grade Point Average"
+    )
+
+    parser.add_argument(
+        "--output",
+        type=str.lower,
+        choices=["gpa", "percent", "letter"],
+        required=True,
+        help="Preferred output method: gpa, percent, or letter",
+    )
+
+    args = parser.parse_args()
+
+    if args.letter is not None:
+        inputVal = args.letter
+
+        if args.output == "gpa":
+            result = "GPA: " + str(letter_to_gpa(inputVal))
+        elif args.output == "percent":
+            result = "Percent: " + str(letter_to_percent(inputVal))
+        else:
+            result = "Letter: " + str(inputVal).upper().strip()
+
+    elif args.gpa is not None:
+        inputVal = args.gpa
+
+        if args.output == "gpa":
+            result = "GPA: " + str(inputVal)
+        elif args.output == "percent":
+            result = "Percent: " + str(gpa_to_percent(inputVal))
+        else:
+            result = "Letter: " + str(gpa_to_letter(inputVal))
+
+    else:
+        inputVal = args.percent
+
+        if args.output == "gpa":
+            result = "GPA: " + str(percent_to_gpa(inputVal))
+        elif args.output == "percent":
+            result = "Percent: " + str(inputVal)
+        else:
+            result = "Letter: " + str(percent_to_letter(inputVal))
+
+    print(result)
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

quickGrade/grades.py

@@ -0,0 +1,111 @@
+gradeRanges = {
+    (97, 100): ["A+", 4.0],
+    (93, 96): ["A", 3.9],
+    (90, 92): ["A-", 3.7],
+    (87, 89): ["B+", 3.3],
+    (83, 86): ["B", 3.0],
+    (80, 82): ["B-", 2.7],
+    (77, 79): ["C+", 2.3],
+    (73, 76): ["C", 2.0],
+    (70, 72): ["C-", 1.7],
+    (67, 69): ["D+", 1.3],
+    (63, 66): ["D", 1.0],
+    (60, 62): ["D-", 0.7],
+    (0, 59): ["F", 0.0],
+}
+
+
+def percent_to_letter(percent: int) -> str:
+    """Input a percent grade and output the corresponding letter grade
+
+    Args:
+        percent (int): The input percent
+
+    Returns:
+        str | ValueError: The output letter grade
+    """
+    if percent < 0 or percent > 100:
+        raise ValueError("Please enter a percent between 0-100 inclusive")
+    for key, val in gradeRanges.items():
+        min, max = key
+        if min <= percent <= max:
+            return val[0]
+    raise ValueError("Unknown error happened ")
+
+
+def letter_to_percent(
+    letter: str, min: bool = False, max: bool = False, avg: bool = True
+) -> int:
+    total = 0
+    if min:
+        total += 1
+    if max:
+        total += 1
+    if avg:
+        total += 1
+    if total != 1:
+        raise ValueError("Please pick only one of max, min, or avg as an arg")
+    
+    for key, val in gradeRanges.items():
+        if val[0] == letter:
+            minV, maxV = key
+            if min:
+                return min
+            if max:
+                return max
+            return int(sum(key) / 2)
+        
+    raise ValueError("Unknown error happened")
+
+def percent_to_gpa(percent:int) -> float:
+    if percent < 0 or percent > 100:
+        raise ValueError("Please enter a percent between 0-100 inclusive")
+    for key, val in gradeRanges.items():
+        min, max = key
+        if min <= percent <= max:
+            return val[1]
+    raise ValueError("Unknown error happened ")
+
+def gpa_to_percent(gpa:float,min: bool = False, max: bool = False, avg: bool = True) -> int:
+    total = 0
+    if min:
+        total += 1
+    if max:
+        total += 1
+    if avg:
+        total += 1
+    if total != 1:
+        raise ValueError("Please pick only one of max, min, or avg as an arg")
+    
+    for key, val in gradeRanges.items():
+        if val[1] == gpa:
+            minV, maxV = key
+            if min:
+                return min
+            if max:
+                return max
+            return int(sum(key) / 2)
+    raise ValueError("Unknown error happened")
+
+def gpa_to_letter(gpa: float) -> str:
+    gpaV = gpa_to_percent(gpa)
+    return percent_to_letter(gpaV)
+
+def letter_to_gpa(letter: str) -> float:
+    return percent_to_gpa(letter_to_percent(letter))
+
+def weightedGPA(percent: int, course_type: str = "regular") -> float:
+    base_gpa = percent_to_gpa(percent)
+
+    course_type = course_type.lower().strip()
+
+    if course_type == "regular":
+        return base_gpa
+
+    if course_type == "honors":
+        return min(base_gpa + 0.5, 5.0)
+
+    if course_type in ["ap", "ib"]:
+        return min(base_gpa + 1.0, 5.0)
+
+    raise ValueError("course_type must be regular, honors, ap, or ib.")

quickgrade-0.1.1.dist-info/METADATA

@@ -0,0 +1,157 @@
+Metadata-Version: 2.4
+Name: quickgrade
+Version: 0.1.1
+Summary: A simple CLI and Python package for converting between letter grades, percentages, and GPA.
+Author: Albin Zieme
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# quickgrade
+
+`quickgrade` is a simple Python package and command-line tool for converting between letter grades, percentages, and GPA values.
+
+It can be used directly in the terminal or imported into your own Python projects.
+
+## Features
+
+- Convert percentage grades to letter grades
+- Convert percentage grades to GPA values
+- Convert letter grades to percentages
+- Convert letter grades to GPA values
+- Convert GPA values to percentages
+- Convert GPA values to letter grades
+- Includes an easy-to-use command-line interface
+
+## Installation
+
+Install with pip:
+
+```bash
+pip install quickgrade
+```
+
+## CLI Usage
+
+After installing, you can use the `quickgrade` command in your terminal.
+
+### Convert a letter grade to a GPA
+
+```bash
+quickgrade --letter A --output gpa
+```
+
+Output:
+
+```text
+GPA: 3.9
+```
+
+### Convert a percentage to a letter grade
+
+```bash
+quickgrade --percent 95 --output letter
+```
+
+Output:
+
+```text
+Letter: A
+```
+
+### Convert a GPA to a percentage
+
+```bash
+quickgrade --gpa 3.7 --output percent
+```
+
+Output:
+
+```text
+Percent: 91
+```
+
+## CLI Arguments
+
+| Argument | Description | Example |
+|---|---|---|
+| `--letter` | Input a letter grade | `--letter A-` |
+| `--percent` | Input a percentage grade | `--percent 95` |
+| `--gpa` | Input a GPA value | `--gpa 3.7` |
+| `--output` | Choose the output type: `letter`, `percent`, or `gpa` | `--output letter` |
+
+Only one input type should be used at a time.
+
+## Python Usage
+
+You can also import the conversion functions in Python.
+
+```python
+from quickGrade.grades import percent_to_letter, percent_to_gpa
+
+print(percent_to_letter(95))
+print(percent_to_gpa(95))
+```
+
+Output:
+
+```text
+A
+3.9
+```
+
+## Available Functions
+
+```python
+percent_to_letter(percent)
+percent_to_gpa(percent)
+
+letter_to_percent(letter)
+letter_to_gpa(letter)
+
+gpa_to_percent(gpa)
+gpa_to_letter(gpa)
+```
+
+## Example
+
+```python
+from quickGrade.grades import letter_to_percent, letter_to_gpa
+
+letter = "B+"
+
+print(letter_to_percent(letter))
+print(letter_to_gpa(letter))
+```
+
+Output:
+
+```text
+88
+3.3
+```
+
+## Grade Scale
+
+The default grading scale is:
+
+| Percent Range | Letter Grade | GPA |
+|---|---:|---:|
+| 97-100 | A+ | 4.0 |
+| 93-96 | A | 3.9 |
+| 90-92 | A- | 3.7 |
+| 87-89 | B+ | 3.3 |
+| 83-86 | B | 3.0 |
+| 80-82 | B- | 2.7 |
+| 77-79 | C+ | 2.3 |
+| 73-76 | C | 2.0 |
+| 70-72 | C- | 1.7 |
+| 67-69 | D+ | 1.3 |
+| 63-66 | D | 1.0 |
+| 60-62 | D- | 0.7 |
+| 0-59 | F | 0.0 |
+
+## License
+
+This project is licensed under the MIT License.

quickgrade-0.1.1.dist-info/RECORD

@@ -0,0 +1,9 @@
+quickGrade/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+quickGrade/cli.py,sha256=IAbdkSEF8yH3vWrxGrZ3BzTLdOPsDDNsiZYzUKvB9ds,2023
+quickGrade/grades.py,sha256=4j9P_acqXU4FujSsPZ0zJXoHcYdzxbUe3HncX9VdLuI,3034
+quickgrade-0.1.1.dist-info/licenses/LICENSE,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+quickgrade-0.1.1.dist-info/METADATA,sha256=oRxkPwyBEwxnlvBzikITl2jHeLIjmnxTe_s8CQ4QLwI,2749
+quickgrade-0.1.1.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+quickgrade-0.1.1.dist-info/entry_points.txt,sha256=a9NQCGpJZ9CQnhcViU4oXwtFl3sHyHVS5YZBnz5OA1Y,51
+quickgrade-0.1.1.dist-info/top_level.txt,sha256=l35fs3eQuy1556Y45Kt96YPf9F_ZtzjuLLPzzEUdX6U,11
+quickgrade-0.1.1.dist-info/RECORD,,

quickgrade-0.1.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

quickgrade-0.1.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+quickgrade = quickGrade.cli:main

quickgrade-0.1.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+quickGrade