juancwu / cp317

Group Project Repo

CP317 PROJECT - Student Grades Formatter

Quick Start

System Requirements

1. Python 3.9.x or later - Download from official site.

Installation Steps

Install using pip.

python3 -m pip install . --use-feature=in-tree-build

Try it out!

Run the command below to start using the program.

sgf

Development Environment Setup

1. Install MiniConda

Follow the installation instructions for your operating system. Download link

2. Setup the virtual environment

conda env create -f env.yml

Testing

Run the command below at the root level of the project.

python3 -m coverage run -m unittest -b

This will run all test cases and generate a coverage report.

Check Test Coverage

View coverage report results.

coverage report

To view report as a website with more details run:

coverage html
python3 -m http.server 5555 --directory ./htmlcov

Install Package as Command Script

NOTE: Only for development environment!

cd /project/root/directory
pip install . --use-feature=in-tree-build

Alternate way to run tests

Run the test.py file in the root level of the project. This option will run the tests but not create a coverage report.

python3 test.py

Extras

Export Environment

conda env export --from-history | grep -v "^prefix: " > env.yml