nicholas.jorgenson/calc-comp
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
14 commits 1 branch 0 tags 50 KiB
Find a file
Exact
Nicholas Jorgenson 0dfbf5464b task: minor documentation tweak
2025-03-07 20:56:59 -05:00
sets task: initial importing and reading of project set files, bug: reformatted set_4 to be consistent with other set files 2025-03-05 16:10:15 -05:00
calc_comp.py task: crunch the numbers and calculate the reimbursement rate 2025-03-07 20:36:45 -05:00
exercise.txt task: inital setup 2025-03-05 15:11:36 -05:00
README.md task: minor documentation tweak 2025-03-07 20:56:59 -05:00

README.md

About

This is a small cli application that calculates the reimbursement amount for a given set of projects.

Here's why:

  • Allows the user calculate their reimbursement amount quickly
  • Allows for multiple concurrent projects to occur in tandem

Getting Started

To try it for your self follow these simple example steps.

Prerequisites

Install dependencies using the following methods.

  • Git
  • Python 3.10.7 or greater

Installation

  1. Clone the repo 
    git clone git@github.com:Jorgensonnj/calc-comp.git

Usage

The cli works right out of the box.

All you need to do is enter the git repo folder

cd calc-comp/

Then run the command

./calc_comp.py

note: the cli will run all sample sets in the set/ directory. If you want to change this, please edit the calc_comp.py file and uncomment individual test sets. (e.g. process_set(DIRECTORY_PATH, "set_1"))

Assumptions

  • The user is familiar with the command line and is able to execute the program
  • The project set files are in the set directory
  • Valid project set lines are formatted correctly and are in their respective project set file